Ctrlk
My Account
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Images

Search Image

Search for images using keywords.

Search images

post
Header parameters
api-keystringRequired
Body
limitnumberOptional
offsetnumberOptional
sortstringOptional
searchstringOptional

Search images by keywords

filterFreebooleanOptional

Search only free images

Responses
200Success
application/json
filteredResultsobjectOptional
post/v1/images/search
POST /v1/images/search HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "limit": 1,
  "offset": 1,
  "sort": "text",
  "search": "text",
  "filterFree": true
}
{
  "filteredResults": {},
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "validate": true,
      "free": true,
      "titles": {}
    }
  ]
}

Download Image (return binary file)

You need to have enough credits. Credits are debited only once.

Download Image

post
Header parameters
api-keystringRequired
Body
idstringRequired

Image ID

Responses
200

Image buffer

No content
post/v1/images/download
POST /v1/images/download HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}
No content

Buy Image (return direct URL)

Same like Download Image, but return direct public link for image. You need to have enough credits. Credits are debited only once.

Buy Image

post
Header parameters
api-keystringRequired
Body
idstringRequired

Image ID

Responses
200Success
application/json
idstringRequired
urlstringRequired

Direct link to download preview image

urlFullstringRequired

Direct link to download full image

urlUpscalestringOptional

Direct link to download upscale image

urlUpscaleUHDstringRequired

Direct link to download upscale UHD image

downloadedAtstring · date-timeRequired

Image download date

post/v1/images/buy
POST /v1/images/buy HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}
{
  "id": "text",
  "url": "text",
  "urlFull": "text",
  "urlUpscale": "text",
  "urlUpscaleUHD": "text",
  "downloadedAt": "2026-01-01T00:00:00.000Z"
}

Display Image

Each image has a display/download URL. Possible formats: "preview" or "full".

Get image

get
Path parameters
imageIdstringRequired
formatstring · enumRequiredPossible values:
Header parameters
api-keystringOptional
Responses
200

Image buffer

No content
get/v1/images/{format}/{imageId}.jpg
GET /v1/images/{format}/{imageId}.jpg HTTP/1.1
Accept: */*

No content

Get Download Images

List images you've downloaded.

Search images downloaded

post
Header parameters
api-keystringRequired
Body
limitnumberOptional
offsetnumberOptional
afterCreatedAtstring · date-timeOptional

Filter images downloaded after date

beforeCreatedAtstring · date-timeOptional

Filter images downloaded before date

Responses
200Success
application/json
filteredResultsnumberOptional
post/v1/images/downladed
POST /v1/images/downladed HTTP/1.1
api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "limit": 1,
  "offset": 1,
  "afterCreatedAt": "2026-01-01T00:00:00.000Z",
  "beforeCreatedAt": "2026-01-01T00:00:00.000Z"
}
{
  "filteredResults": 1,
  "images": [
    {
      "id": "text",
      "url": "text",
      "urlFull": "text",
      "urlUpscale": "text",
      "urlUpscaleUHD": "text",
      "downloadedAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}
PreviousAPI Reference
NextImages generation

Last updated