Sign in
V2
Batches

Create Batch

Create a batch over a source directory and start processing asynchronously.

post/api/v2/batches

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

source_directory_idstring required

Directory whose files should be processed.

Example request

{
  "source_directory_id": "dir-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "config": {
    "job": {
      "configuration_id": "cfg-PARSE_AGENTIC"
    }
  }
}

Response

Successful Response

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring required

Project this batch belongs to.

source_directory_idstring required

Directory being processed.

status'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

Current batch status.

Example response

{
  "config": {
    "job": {
      "configuration_id": "cfg-PARSE_AGENTIC"
    }
  },
  "results": [
    {
      "source_directory_file_id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "job_reference": {
        "id": "pjb-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
      }
    }
  ]
}

Changes

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

  • b17341164de92See the full diff
    • ○

      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

  • 00f6a6ae33ca1See the full diff
    • ○

      endpoint added

      endpoint-added