Queue

Poll job status

get

Check the status and queue position of an async processing job.

Query parameters
jobIdstringRequired

Job ID from the 202 response

jobTokenstringRequired

Job token for authorization

Responses
chevron-right
200

Job status

application/json
statusstring · enumOptionalPossible values:
positionintegerOptional
estimatedWaitMsintegerOptional
errorstringOptional
get
/api/queue

Cancel a queued job

delete

Cancel a job that hasn't started processing yet.

Query parameters
jobIdstringRequired
jobTokenstringRequired
Responses
chevron-right
200

Job cancelled

application/json
cancelledbooleanOptional
delete
/api/queue

Fetch completed job result

get

Download the processed file after job completes. One-time fetch — result is purged after retrieval.

Query parameters
jobIdstringRequired
jobTokenstringRequired
Responses
chevron-right
200

Processed file binary

application/octet-stream
string · binaryOptional
get
/api/queue/result

Last updated