Batches

Create Messages Batch

Submit a batch of agent messages for asynchronous processing. Creates a job that will fan out messages to all listed agents and process them in parallel.

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
requestslist of objectsRequired

List of requests to be processed in batch.

callback_urlstringOptionalformat: "uri">=1 character<=2083 characters

Optional URL to call via POST when the batch completes. The callback payload will be a JSON object with the following fields: {‘job_id’: string, ‘status’: string, ‘completed_at’: string}. Where ‘job_id’ is the unique batch job identifier, ‘status’ is the final batch status (e.g., ‘completed’, ‘failed’), and ‘completed_at’ is an ISO 8601 timestamp indicating when the batch job completed.

Response

Successful Response

created_by_idstringOptional

The id of the user that made this object.

last_updated_by_idstringOptional

The id of the user that made this object.

created_atstringOptionalformat: "date-time"

The timestamp when the object was created.

updated_atstringOptionalformat: "date-time"

The timestamp when the object was last updated.

statusenumOptional

The status of the job.

completed_atstringOptionalformat: "date-time"

The unix timestamp of when the job was completed.

metadataobjectOptional

The metadata of the job.

job_typeenumOptional
Allowed values:
callback_urlstringOptional

If set, POST to this URL when the job completes.

callback_sent_atstringOptionalformat: "date-time"

Timestamp when the callback was last attempted.

callback_status_codeintegerOptional

HTTP status code returned by the callback endpoint.

idstringOptionalformat: "^(job|run)-[a-fA-F0-9]{8}"

The human-friendly ID of the Job