Retrieve a batch | Respan Docs

Retrieve details of a batch processing job.

batch_idstringRequired

The unique identifier of the batch to retrieve. Format: batch_xxxxx

Batch details.

idstring

Batch ID.

statusenum

Batch status.

input_file_idstring

output_file_idstring or null

Output file ID (available when completed).

error_file_idstring or null

Error file ID (if errors occurred).

endpointstring

completion_windowstring

created_atinteger

completed_atinteger or null

request_countsobject

metadataobject

401

Unauthorized Error

404

Not Found Error

1	{
2	"id": "batch_9f8e7d6c5b4a3",
3	"status": "in_progress",
4	"input_file_id": "file_input_20240601",
5	"endpoint": "https://api.respan.ai/v1/llm/completions",
6	"completion_window": "2024-06-01T12:00:00Z to 2024-06-01T12:30:00Z",
7	"created_at": 1717185600,
8	"request_counts": {
9	"total": 1500,
10	"completed": 1200,
11	"failed": 50
12	},
13	"metadata": {
14	"model": "gpt-4",
15	"priority": "high",
16	"initiated_by": "user_12345"
17	}
18	}

1	curl https://api.respan.ai/api/v1/batches/batch_id/ \
2	-H "Authorization: Bearer sk_live_xxxxx" \
3	-H "Content-Type: application/json"