Beta
Batch Processing

List Batch Jobs

Changed on

List batch processing jobs with optional filtering.

Filter by directory_id, job_type, or status. Results are paginated with configurable limit and offset.

get/api/v1/beta/batch-processing

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

directory_idstring nullable

Filter by directory ID

job_type'parse' | 'extract' | 'classify'

Type of batch processing operation.

Filter by job type (PARSE, EXTRACT, CLASSIFY)

status'pending' | 'running' | 'dispatched' | 'completed' | 'failed' | 'cancelled'

Status of a batch processing job.

Filter by job status (PENDING, RUNNING, COMPLETED, FAILED, CANCELLED)

limitinteger

Maximum number of jobs to return

offsetinteger

Number of jobs to skip for pagination

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

next_page_tokenstring nullable

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_sizeinteger nullable

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Example response

{
  "items": [
    {
      "id": "bjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "project_id": "proj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "directory_id": "dir-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
    }
  ]
}

Changes

  • b17341164de9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status