Job Queue

Document extraction requests are processed in a job queue. Use the following endpoints to monitor queue status.

Get Job Queue

GET /workspace/get-queue

Get a workspace's job queue

Request

Headers

An API Key is required to access this endpoint.

Name	Value
x-api-key	your_api_key

Response

The API returns the response in JSON format.

Each response includes an array of jobs and a workspaceId. Each individual job request can have a status of PENDING, IN_PROGRESS, RETRY, COMPLETE or ERROR and a type of SYNC, GENERATE or PIPELINE.

Example

200

{
  "jobs": [
    {
      "duration": 1213,
      "endedAt": "2024-04-30T23:02:31.795Z",
      "id": "2f0c75e6-f14f-4e97-8fdf-222cd6b66c68",
      "jobId": "a26da7d2-a976-43e5-8290-0ce430ce035a",
      "retryCount": 0,
      "startedAt": "2024-04-30T23:02:30.582Z",
      "status": "COMPLETE",
      "type": "SYNC"
    },
    {
      "duration": 3184,
      "endedAt": "2024-04-30T23:02:33.766Z",
      "id": "ed5ed2de-d724-4c4a-91d8-81cc5635f0b7",
      "jobId": "a26da7d2-a976-43e5-8290-0ce430ce035a",
      "retryCount": 0,
      "startedAt": "2024-04-30T23:02:30.582Z",
      "status": "COMPLETE",
      "type": "SYNC"
    }
  ...
  ],
  "workspaceId": "f47ab737-4900-4357-b198-286b3c6e215b"
}

400

{
  "error": "Invalid request"
}

Get Queue Statistics

GET /workspace/get-queue-statistics

Get a workspace's job queue statistics

Request

Headers

An API Key is required to access this endpoint.

Name	Value
x-api-key	your_api_key

Response

The API returns the response in JSON format.

Each response includes a workspaceId and a jobsByStatus object with the count of jobs categorized by their status.

Example

200

{
  "jobsByStatus": {
    "PENDING": 0,
    "IN_PROGRESS": 0,
    "RETRY": 0,
    "COMPLETE": 50,
    "ERROR": 0
  },
  "workspaceId": "f47ab737-4900-4357-b198-286b3c6e215b"
}

400

{
  "error": "Invalid request"
}