Create a batch | Respan Docs

Create an OpenAI-compatible batch processing job from an uploaded JSONL file.

Request

This endpoint expects an object.

input_file_idstringRequired

Uploaded JSONL file ID.

endpointenumRequired

Endpoint each JSONL request targets.

Allowed values:

completion_windowenumRequired

Allowed values:

metadatamap from strings to anyOptional

Custom metadata for tracking.

customer_identifierstringOptional

End-user identifier for logging.

custom_identifierstringOptional

Custom identifier for querying.

thread_identifierstringOptional

Conversation thread identifier.

environmentstringOptional

Environment tag.

Response

Created batch.

idstring

Batch ID.

statusenum

objectstring

endpointstring

input_file_idstring

output_file_idstring or null

Output file ID, available when the batch completes.

error_file_idstring or null

Error file ID, when provider errors are available.

completion_windowstring

created_atinteger

Unix timestamp.

in_progress_atinteger or null

expires_atinteger or null

finalizing_atinteger or null

completed_atinteger or null

failed_atinteger or null

expired_atinteger or null

cancelling_atinteger or null

cancelled_atinteger or null

request_countsobject

metadatamap from strings to any

errorsany or null

Provider error details, when available.

Errors

400

Bad Request Error

401

Unauthorized Error

$	curl -X POST https://api.respan.ai/api/v1/batches \
>	-H "Authorization: Bearer sk_live_xxxxx" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"input_file_id": "file-9f8b7c6d",
>	"endpoint": "/v1/chat/completions",
>	"completion_window": "24h"
>	}'

1	{
2	"id": "batch_4e5f6a7b",
3	"status": "in_progress",
4	"object": "batch",
5	"endpoint": "/v1/chat/completions",
6	"input_file_id": "file-9f8b7c6d",
7	"output_file_id": "file-output-123abc",
8	"error_file_id": "file-error-456def",
9	"completion_window": "24h",
10	"created_at": 1710001234,
11	"in_progress_at": 1710002234,
12	"expires_at": 1710088634,
13	"finalizing_at": 0,
14	"completed_at": 0,
15	"failed_at": 0,
16	"expired_at": 0,
17	"cancelling_at": 0,
18	"cancelled_at": 0,
19	"request_counts": {
20	"total": 100,
21	"completed": 97,
22	"failed": 3
23	},
24	"metadata": {},
25	"errors": null
26	}

Headers

Request

Response

Errors