Skip to main content
GET
/
ai
/
batches
Batch completions
curl --request GET \
  --url https://api.agentfirst.dev/ai/batches \
  --header 'Authorization: Bearer <token>'
{
  "id": "a0482596-c2ad-445a-a435-727002156a20",
  "status": "retrieving",
  "count": 37,
  "successful": 37,
  "failed": 0,
  "url": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string<uuid>
required

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

Example:

"a0482596-c2ad-445a-a435-727002156a20"

Response

The batch status.

​
id
string<uuid>
required

The identifier to retrieve the batch job with.

Example:

"a0482596-c2ad-445a-a435-727002156a20"

​
status
enum<string>
required

The status of the batch job.

Available options:
retrieving,
archiving,
successful,
failed
Example:

"retrieving"

​
count
integer
required

The number of batch requests.

Required range: 1 <= x <= 1000
Example:

37

​
successful
integer
required

The number of successful requests in the batch.

Required range: 0 <= x <= 1000
Example:

37

​
failed
integer
required

The number of failed requests in the batch.

Required range: 0 <= x <= 1000
Example:

0

​
url
string<uri>

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

Example:

null