Jobs

Get job status

Returns the current status and result of a specific job

get/jobs/{jobId}

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/jobs/{jobId}
  • Auth: HTTP bearer

Path parameters

jobIdstring required

Job ID returned from POST /jobs

Response

Job details

jobIdstring
status'queued' | 'processing' | 'completed' | 'failed' | 'partial'
progressnumber
resultobject
errorstring
createdAtstring date-time
finishedAtstring date-time

Example response

{
  "jobId": "doc-101-1711820400000",
  "progress": 50
}

Changes

No recorded changes to this operation across all 1 revision of this API.