Skip to main content
GET
https://api.neosantara.xyz
/
v1
/
batches
/
:batch_id
Get Batch
curl --request GET \
  --url https://api.neosantara.xyz/v1/batches/:batch_id \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "object": "<string>",
  "endpoint": "<string>",
  "errors": {},
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "<string>",
  "output_file_id": {},
  "error_file_id": {},
  "created_at": 123,
  "in_progress_at": {},
  "expires_at": 123,
  "finalizing_at": {},
  "completed_at": {},
  "failed_at": {},
  "expired_at": {},
  "cancelling_at": {},
  "cancelled_at": {},
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123
  },
  "metadata": {}
}
Retrieve the status and details of a specific batch job.
​
batch_id
string
required
The ID of the batch to retrieve (e.g., batch-abc123).

​
Returns

​
id
string
The unique identifier of the batch.
​
object
string
The object type, which is always batch.
​
endpoint
string
The API endpoint used for all requests in the batch.
​
errors
object or null
Any errors encountered during batch processing.
​
input_file_id
string
The ID of the input file.
​
completion_window
string
The time window for batch completion.
​
status
string
The current status of the batch. See status values in Create Batch endpoint.
​
output_file_id
string or null
The ID of the output file with successful results.
​
error_file_id
string or null
The ID of the error file with failed requests.
​
created_at
integer
The Unix timestamp of when the batch was created.
​
in_progress_at
integer or null
The Unix timestamp when processing started.
​
expires_at
integer
The Unix timestamp when the batch expires.
​
finalizing_at
integer or null
The Unix timestamp when finalizing started.
​
completed_at
integer or null
The Unix timestamp when the batch completed.
​
failed_at
integer or null
The Unix timestamp when the batch failed.
​
expired_at
integer or null
The Unix timestamp when the batch expired.
​
cancelling_at
integer or null
The Unix timestamp when cancellation was initiated.
​
cancelled_at
integer or null
The Unix timestamp when the batch was cancelled.
​
request_counts
object
Statistics about the batch requests.
​
metadata
object
Custom metadata for the batch.
{
  "id": "batch-abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file-xyz789",
  "completion_window": "24h",
  "status": "in_progress",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1699564800,
  "in_progress_at": 1699565000,
  "expires_at": 1699651200,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 45,
    "failed": 2
  },
  "metadata": {}
}