Beta
Split

List Split Jobs

List document split jobs.

get/api/v1/beta/split/jobs

Query parameters

status'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' nullable

Filter by job status (pending, processing, completed, failed, cancelled)

Filter by job status (pending, processing, completed, failed, cancelled)

job_idsstring[] nullable

Filter by specific job IDs

Filter by specific job IDs

project_idstring uuid nullable
organization_idstring uuid nullable
page_sizeinteger nullable
page_tokenstring nullable
created_at_on_or_afterstring date-time nullable

Include items created at or after this timestamp (inclusive)

Include items created at or after this timestamp (inclusive)

created_at_on_or_beforestring date-time nullable

Include items created at or before this timestamp (inclusive)

Include items created at or before this timestamp (inclusive)

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

Changed in 1 of the 33 revisions of this API.2

    • added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog