Sign in
Beta
Batch Processing

List Batch Jobs

Changed on

List all batch processing jobs for a project with optional filtering.

Returns a paginated list of batch jobs with filters for directory, job type, and status. Useful for viewing job history, monitoring progress, and finding specific jobs.

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.

Changes