Get a batch

GET {base_url}/v1/batches/{id}

Error

A valid request URL is required to generate request examples

200

{
  "cancelled_at": 123,
  "cancelling_at": 123,
  "completed_at": 123,
  "completion_window": "<string>",
  "created_at": 123,
  "endpoint": "<string>",
  "failed_at": 123,
  "id": "<string>",
  "in_progress_at": 123,
  "input_file_id": "<string>",
  "metadata": {},
  "object": "<string>",
  "provider": "<string>",
  "provider_batch_id": "<string>",
  "request_counts": {
    "completed": 123,
    "failed": 123,
    "total": 123
  },
  "results": [
    {
      "custom_id": "<string>",
      "error": {
        "message": "<string>",
        "type": "<string>"
      },
      "index": 123,
      "model": "<string>",
      "provider": "<string>",
      "response": "<unknown>",
      "status_code": 123,
      "url": "<string>"
    }
  ],
  "status": "<string>",
  "usage": {
    "input_cost": 123,
    "input_tokens": 123,
    "output_cost": 123,
    "output_tokens": 123,
    "total_cost": 123,
    "total_tokens": 123
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Batch ID

Response

200

application/json

OK

cancelled_at · integer

cancelling_at · integer

completed_at · integer

completion_window · string

created_at · integer

endpoint · string

failed_at · integer

id · string

in_progress_at · integer

input_file_id · string

metadata · object

Show child attributes

object · string

provider · string

provider_batch_id · string

request_counts · object

Show child attributes

results · object[]

Show child attributes

status · string

usage · object

Gateway extension: optional usage/result snapshots persisted by the gateway.

Show child attributes