Poll job status

curl --request GET \
  --url https://api.example.com/api/jobs/poll \
  --header 'x-api-key: <api-key>'

{
  "id": 123,
  "status": "PENDING",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "results": [
    {}
  ]
}

GET

api

jobs

poll

Poll job status

curl --request GET \
  --url https://api.example.com/api/jobs/poll \
  --header 'x-api-key: <api-key>'

{
  "id": 123,
  "status": "PENDING",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "results": [
    {}
  ]
}

x-api-key

string

header

required

jobId

integer<int64>

required

ID of the job to check

Job status retrieved successfully

integer<int64>

status

enum<string>

Available options:

PENDING,

PROCESSING,

COMPLETED,

FAILED

createdAt

string<date-time>

updatedAt

string<date-time>

results

object[]

⌘I