v36

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-091882241.2 MB
messages

List Messages For Batch

Get response messages for a specific batch job.

get/v1/messages/batches/{batch_id}/messages

Path parameters

batch_idstring required

Query parameters

beforestring nullable

Message ID cursor for pagination. Returns messages that come before this message ID in the specified sort order

Message ID cursor for pagination. Returns messages that come before this message ID in the specified sort order

afterstring nullable

Message ID cursor for pagination. Returns messages that come after this message ID in the specified sort order

Message ID cursor for pagination. Returns messages that come after this message ID in the specified sort order

limitinteger nullable

Maximum number of messages to return

Maximum number of messages to return

order'asc' | 'desc'

Sort order for messages by creation time. 'asc' for oldest first, 'desc' for newest first

Sort order for messages by creation time. 'asc' for oldest first, 'desc' for newest first

order_by'created_at'

Field to sort by

Field to sort by

agent_idstring nullable

Filter messages by agent ID

Filter messages by agent ID

Response

Successful Response

Example response

{
  "messages": [
    {
      "id": "message-123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}