List your jobs

Cursor-paginated. A recovery path when a client loses job ids. Lists image generation jobs only; style-extraction jobs are polled individually via GET /styles/extractions/{id}.

GET /jobs

List your jobs

cURL

curl --request GET \
  --url http://localhost:3001/api/v1/jobs \
  --header 'x-api-key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "result": {
        "images": [
          {
            "id": "<string>",
            "url": "<string>",
            "width": 0,
            "height": 0
          }
        ],
        "video": {
          "id": "<string>",
          "url": "<string>",
          "durationSeconds": 0,
          "thumbnailUrl": "<string>",
          "width": 0,
          "height": 0
        },
        "style": {
          "id": "<string>"
        }
      },
      "error": {
        "message": "<string>"
      }
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

apiKeybearerAuth

x-api-key · string · header · required

Query Parameters

cursor · string

Opaque pagination cursor returned as nextCursor by a prior call.

limit · integer · default: 20

Max items per page.

Required range: 1 <= x <= 50

status · enum<string>

Filter by job status.

Available options: pending, processing, completed, failed

Response

200

application/json

OK

data · object[] · required

Show child attributes

nextCursor · string | null