Skip to main content
GET
/
batches
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "object": "batch",
  "endpoint": "<string>",
  "errors": {
    "object": "list",
    "data": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>",
        "line": 123
      }
    ]
  },
  "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

API key passed as a Bearer token.

Path Parameters

id
string
required

Batch ID.

Response

Batch object

id
string
object
string
Example:

"batch"

endpoint
string
errors
object
input_file_id
string
completion_window
string
status
enum<string>
Available options:
validating,
in_progress,
completed,
failed,
expired,
cancelling,
cancelled
output_file_id
string
error_file_id
string
created_at
integer<int64>
in_progress_at
integer<int64> | null
expires_at
integer<int64> | null
finalizing_at
integer<int64> | null
completed_at
integer<int64> | null
failed_at
integer<int64> | null
expired_at
integer<int64> | null
cancelling_at
integer<int64> | null
cancelled_at
integer<int64> | null
request_counts
object
metadata
object