batches

Retry specific requests

Retry specific failed requests by their IDs.

Use this for fine-grained control over which requests to retry, rather than retrying all failures.

post/batches/{batch_id}/retry-requests

Path parameters

batch_idstring required

The batch ID returned when the batch was created.

Request body

request_idsstring[] required

Array of request IDs to retry

Example request

{
  "request_ids": [
    "req-abc123",
    "req-def456"
  ]
}

Response

Specified requests queued for retry.

cancelled_atinteger nullable

cancelling_atinteger nullable

completed_atinteger nullable

completion_windowstring required

The requested processing window, or "background" for no-SLA spare-capacity processing.

created_atinteger required

endpointstring required

error_file_idstring nullable

expired_atinteger nullable

expires_atinteger nullable

failed_atinteger nullable

finalizing_atinteger nullable

idstring required

in_progress_atinteger nullable

input_file_idstring required

metadataobject nullable

modelstring nullable

Model alias used by this batch's requests, or "mixed" when the input file spans multiple models. Cached on the batch at creation time; absent on batches created before this field existed.

object'batch' required

Object type - always "batch"

output_file_idstring nullable

statusstring required

Example response

{
  "completed_at": 1703190800,
  "completion_window": "24h",
  "created_at": 1703187200,
  "endpoint": "/v1/chat/completions",
  "id": "batch-abc123",
  "input_file_id": "file-abc123",
  "object": "batch",
  "output_file_id": "file-xyz789",
  "request_counts": {
    "completed": 98,
    "failed": 2,
    "total": 100
  },
  "status": "completed"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.