Skip to main content
GET
/
batches
/
{batch_id}
Retrieve batch
curl --request GET \
  --url https://api.anyapi.ai/v1/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "batch",
  "endpoint": "<string>",
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "validating",
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "created_at": 123,
  "in_progress_at": 123,
  "expires_at": 123,
  "finalizing_at": 123,
  "completed_at": 123,
  "failed_at": 123,
  "expired_at": 123,
  "cancelling_at": 123,
  "cancelled_at": 123,
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Get your API key from the dashboard.

Path Parameters

​
batch_id
string
required

The ID of the batch to retrieve

Response

Successful response

​
id
string
required

The batch identifier

​
object
enum<string>
required

The object type, which is always 'batch'

Available options:
batch
​
endpoint
string
required

The endpoint used for the batch

​
input_file_id
string
required

The ID of the input file for the batch

​
completion_window
string
required

The time frame within which the batch should be processed

​
status
enum<string>
required

The current status of the batch

Available options:
validating,
failed,
in_progress,
finalizing,
completed,
expired,
cancelling,
cancelled
​
created_at
integer
required

The Unix timestamp (in seconds) for when the batch was created

​
output_file_id
string | null

The ID of the file containing the outputs of successfully executed requests

​
error_file_id
string | null

The ID of the file containing the outputs of requests with errors

​
in_progress_at
integer | null

The Unix timestamp (in seconds) for when the batch started processing

​
expires_at
integer | null

The Unix timestamp (in seconds) for when the batch will expire

​
finalizing_at
integer | null

The Unix timestamp (in seconds) for when the batch started finalizing

​
completed_at
integer | null

The Unix timestamp (in seconds) for when the batch was completed

​
failed_at
integer | null

The Unix timestamp (in seconds) for when the batch failed

​
expired_at
integer | null

The Unix timestamp (in seconds) for when the batch expired

​
cancelling_at
integer | null

The Unix timestamp (in seconds) for when the batch started cancelling

​
cancelled_at
integer | null

The Unix timestamp (in seconds) for when the batch was cancelled

​
request_counts
object
​
metadata
object | null

Set of key-value pairs attached to the object

⌘I