Skip to main content
GET
/
jobs
List your jobs
curl --request GET \
  --url http://localhost:3001/api/v1/jobs \
  --header 'x-api-key: <api-key>'
{
  "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

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

OK

data
object[]
required
nextCursor
string | null