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
Authorization
Header authentication of the form Bearer <token>
Request
This endpoint expects an object.
requests
List of requests to be processed in batch.
callback_url
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_id
The id of the user that made this object.
last_updated_by_id
The id of the user that made this object.
created_at
The timestamp when the object was created.
updated_at
The timestamp when the object was last updated.
status
The status of the job.
completed_at
The unix timestamp of when the job was completed.
metadata
The metadata of the job.
job_type
Allowed values:
callback_url
If set, POST to this URL when the job completes.
callback_sent_at
Timestamp when the callback was last attempted.
callback_status_code
HTTP status code returned by the callback endpoint.
callback_error
Optional error message from attempting to POST the callback endpoint.
id
The human-friendly ID of the Job