Skip to navigation
SDK ReferenceBatch

Create batch

Authentication

AuthorizationApi-Key

Type "Api-Key" followed by a space and the project API key.

Request

Request body
ignore_roleslist of stringsOptional
Message roles to skip during graph extraction for thread message items in this batch.
metadatamap from strings to anyOptional
Metadata to store on the batch.
strict_ontologybooleanOptional
When true, prevents extraction of generic entity nodes that do not match the configured ontology for episodes in this batch.

Response

Created
created_atstringOptional
The time the batch was created.
metadatamap from strings to anyOptional
Custom metadata associated with the batch, supplied when it was created.
progressmap from strings to anyOptional
The batch's processing progress, including its current stage and item counts. Present only once processing has started.
statusstringOptional

The processing status of the batch: draft, invalid, queued, processing, succeeded, partial, failed, or canceled.

strict_ontologybooleanOptional
Whether ontology enforcement is applied when this batch is processed, rejecting entities that do not match the configured ontology.
uuidstringOptional
The unique identifier of the batch.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error