Batchesmessages

List Batch Messages

Get messages for a specific batch job.

Returns messages associated with the batch in chronological order.

Pagination:

  • For the first page, omit the cursor parameter
  • For subsequent pages, use the ID of the last message from the previous response as the cursor
  • Results will include messages before/after the cursor based on sort_descending

Path parameters

batch_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Query parameters

limitintegerOptionalDefaults to 100
Maximum number of messages to return
cursorstring or nullOptional

Message ID to use as pagination cursor (get messages before/after this ID) depending on sort_descending.

agent_idstring or nullOptional
Filter messages by agent ID
sort_descendingbooleanOptionalDefaults to true

Sort messages by creation time (true=newest first)

Response

Successful Response
messageslist of objects

Errors