Sign in

v9

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01211389.1 KB

Batch completions

Retrieve the status of batch conversations.

get/ai/batches

Query parameters

idstring uuid required
Example:a0482596-c2ad-445a-a435-727002156a20

The identifier returned by the batch AI endpoint of the bulk conversations to retrieve.

Response

The batch status.

idstring uuid required

The identifier to retrieve the batch job with.

status'retrieving' | 'archiving' | 'successful' | 'failed' required
countinteger required

The number of batch requests.

successfulinteger required

The number of successful requests in the batch.

failedinteger required

The number of failed requests in the batch.

urlstring uri

The URL of the archived requests, which is available on job completion.

Example response

{
  "id": "a0482596-c2ad-445a-a435-727002156a20",
  "status": "retrieving",
  "count": 37,
  "successful": 37
}