Skip to main content
GET
Retrieve batch
Retrieve batch using its batch ID.

Request Headers

string
required
Enum: application/json
string
required
Bearer authentication format, for example: Bearer {{API Key}}.

Path Parameters

string
required
The unique identifier of the batch job to check.

Response

string
required
A unique identifier for the batch job.
string
required
The object type, which is always batch.
string
required
The API endpoint that the batch job is using for processing requests.
string
required
The ID of the input file containing the batch requests.
string
required
The ID of the output file containing the batch results. Empty until the batch is completed.
string
required
The ID of the error file containing any errors that occurred during batch processing. Empty until errors occur.
string
required
The time window for batch completion. Currently fixed at 48h.
string | null
The timestamp when the batch started processing. Null if not yet started.
string | null
The timestamp when the batch will expire. Null if not set.
string | null
The timestamp when the batch started finalizing. Null if not yet finalizing.
string | null
The timestamp when the batch was completed. Null if not yet completed.
string | null
The timestamp when the batch failed. Null if not failed.
string | null
The timestamp when the batch expired. Null if not expired.
string | null
The timestamp when the batch started cancelling. Null if not cancelling.
string | null
The timestamp when the batch was cancelled. Null if not cancelled.
string
required
The current status of the batch job.Available statuses:
  • VALIDATING - The input file is being validated before the batch can begin
  • PROGRESS - Batch is in progress
  • COMPLETED - Batch processing completed successfully
  • FAILED - Batch processing failed
  • EXPIRED - Batch exceeded deadline
  • CANCELLING - Batch is being cancelled
  • CANCELLED - Batch was cancelled
string
Error messages if any errors occurred during batch processing.
integer
required
The version number of the batch job.
string
required
The timestamp when the batch job was created.
string | null
The timestamp when the batch job was last updated. Null if never updated.
string
required
The unique identifier of the user who created the batch job.
string
required
The API key ID used to create the batch job.
string
Optional remark or note for the batch job.
integer
required
The total number of requests in the batch.
integer
required
The number of completed requests in the batch.
integer
required
The number of failed requests in the batch.
object | null
Additional metadata associated with the batch job. Null if no metadata is provided.
object
required
Detailed request count information.
Last modified on August 12, 2025