Skip to main content
GET
/
images
/
{id}
Get an image job
curl --request GET \
  --url http://localhost:3001/api/v1/images/{id} \
  --header 'x-api-key: <api-key>'
{
  "data": {
    "id": "3f9a4c2e-7b1d-4e8a-9c3f-2a1b0c9d8e7f",
    "type": "image.generate",
    "status": "completed",
    "createdAt": "2026-06-16T10:00:00.000Z",
    "result": {
      "images": [
        {
          "id": "8c1d2e3f-0001-4a2b-9c3d-1a2b3c4d5e01",
          "url": "https://cdn.example.com/assets/u_123/8c1d2e3f01/original.png",
          "width": 2048,
          "height": 2048
        },
        {
          "id": "8c1d2e3f-0002-4a2b-9c3d-1a2b3c4d5e02",
          "url": "https://cdn.example.com/assets/u_123/8c1d2e3f02/original.png",
          "width": 2048,
          "height": 2048
        }
      ]
    }
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Query Parameters

wait
enum<string>

When true, hold the connection until the job is terminal (up to ~55s), then return its current state. On timeout the job may still be pending/processing; re-issue the request to keep waiting.

Available options:
true

Response

OK

data
object
required