Retrieve batch

GEThttps://api.openai.com/v1/batches/batch_abc123

Retrieves a batch.

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Header Params

Authorization

string

required

Example:

Bearer $OPENAI_API_KEY

Content-Type

string

required

Example:

application/json

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

string

required

object

string

required

endpoint

string

required

errors

null

required

input_file_id

string

required

completion_window

string

required

status

string

required

output_file_id

string

required

error_file_id

string

required

created_at

integer

required

in_progress_at

integer

required

expires_at

integer

required

finalizing_at

integer

required

completed_at

integer

required

failed_at

null

required

expired_at

null

required

cancelling_at

null

required

cancelled_at

null

required

request_counts

object

required

total

integer

required

completed

integer

required

failed

integer

required

metadata

object

required

customer_id

string

required

batch_description

string

required

{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "completed",
  "output_file_id": "file-cvaTdG",
  "error_file_id": "file-HOWS94",
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": 1711493133,
  "completed_at": 1711493163,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 95,
    "failed": 5
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Nightly eval job",
  }
}

Last modified: 2 months ago