Beta
Split

Create Split Job

Create a document split job.

post/api/v1/beta/split/jobs

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

configuration_idstring nullable

Saved split configuration ID.

Response

Successful Response

idstring required

Unique identifier for the split job.

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project ID this job belongs to.

user_idstring required

User ID who created this job.

configuration_idstring nullable

Split configuration ID used for this job.

statusstring required

Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.

error_messagestring nullable

Error message if the job failed.

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