List batches

GET

batches

List batches

curl --request GET \
  --url https://api.anyapi.ai/v1/batches \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "batch",
      "endpoint": "<string>",
      "input_file_id": "<string>",
      "completion_window": "<string>",
      "status": "validating",
      "created_at": 123,
      "output_file_id": "<string>",
      "error_file_id": "<string>",
      "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": {}
    }
  ],
  "first_id": "<string>",
  "last_id": "<string>",
  "has_more": true
}

Authorizations

Authorization

string

header

required

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

Query Parameters

after

string

A cursor for use in pagination

limit

integer

default:20

A limit on the number of objects to be returned

Response

Successful response

object

enum<string>

required

The object type, which is always 'list'

Available options:

list

data

object[]

required

Array of batch objects

Show child attributes

data.id

string

required

The batch identifier

data.object

enum<string>

required

The object type, which is always 'batch'

Available options:

batch

data.endpoint

string

required

The endpoint used for the batch

data.input_file_id

string

required

The ID of the input file for the batch

data.completion_window

string

required

The time frame within which the batch should be processed

data.status

enum<string>

required

The current status of the batch

Available options:

validating,

failed,

in_progress,

finalizing,

completed,

expired,

cancelling,

cancelled

data.created_at

integer

required

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

data.output_file_id

string | null

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

data.error_file_id

string | null

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

data.in_progress_at

integer | null

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

data.expires_at

integer | null

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

data.finalizing_at

integer | null

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

data.completed_at

integer | null

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

data.failed_at

integer | null

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

data.expired_at

integer | null

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

data.cancelling_at

integer | null

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

data.cancelled_at

integer | null

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

data.request_counts

object

Show child attributes

data.request_counts.total

integer

required

Total number of requests in the batch

data.request_counts.completed

integer

required

Number of requests that have been completed successfully

data.request_counts.failed

integer

required

Number of requests that have failed

data.metadata

object

Set of key-value pairs attached to the object

Show child attributes

data.metadata.{key}

string

first_id

string

First ID in the retrieved list

last_id

string

Last ID in the retrieved list

has_more

boolean

Whether there are more batches available

Create batchCreates and executes a batch from an uploaded file of requests

⌘I

List batches

curl --request GET \
  --url https://api.anyapi.ai/v1/batches \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "batch",
      "endpoint": "<string>",
      "input_file_id": "<string>",
      "completion_window": "<string>",
      "status": "validating",
      "created_at": 123,
      "output_file_id": "<string>",
      "error_file_id": "<string>",
      "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": {}
    }
  ],
  "first_id": "<string>",
  "last_id": "<string>",
  "has_more": true
}

Get started

Features

Use Cases

Developer guides

API Reference

Integrations

Authorizations

Query Parameters

Response