Create a batch | Respan Docs

Create a new batch processing job from an uploaded JSONL file.

This endpoint expects an object.

input_file_idstringRequired

ID of the uploaded JSONL file. Get from Upload file endpoint.

endpointenumRequired

API endpoint for batch requests.

Allowed values:

completion_windowenumRequired

Processing time frame.

Allowed values:

metadataobjectOptional

Custom key-value pairs for tracking.

customer_identifierstringOptional

End user identifier.

custom_identifierstringOptional

Custom identifier for fast querying.

thread_identifierstringOptional

Conversation thread ID.

environmentstringOptional

Environment tag.

Created batch.

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

1	curl -X POST https://api.respan.ai/api/v1/batches/ \
2	-H "Authorization: Bearer sk_live_xxxxx" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"input_file_id": "file-xyz789",
6	"endpoint": "/v1/chat/completions",
7	"completion_window": "24h"
8	}'

1	{
2	"id": "batch_xyz789",
3	"status": "validating",
4	"input_file_id": "file-xyz789",
5	"output_file_id": "file-output-456def",
6	"error_file_id": "file-error-123abc",
7	"endpoint": "/v1/chat/completions",
8	"completion_window": "24h",
9	"created_at": 1712000000,
10	"completed_at": 1712086400,
11	"request_counts": {
12	"total": 150,
13	"completed": 145,
14	"failed": 5
15	},
16	"metadata": {}
17	}