List batches

GET

https://api.respan.ai/api/v1/batches

GET

/api/v1/batches

$ curl -G https://api.respan.ai/api/v1/batches \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -d provider_id=provider_id

1 {
2   "object": "list",
3   "data": [
4     {
5       "id": "batch_abc123",
6       "status": "in_progress",
7       "object": "batch",
8       "endpoint": "/v1/chat/completions",
9       "input_file_id": "file-abc123",
10       "output_file_id": "string",
11       "error_file_id": "string",
12       "completion_window": "24h",
13       "created_at": 1710000000,
14       "in_progress_at": 1,
15       "expires_at": 1,
16       "finalizing_at": 1,
17       "completed_at": 1,
18       "failed_at": 1,
19       "expired_at": 1,
20       "cancelling_at": 1,
21       "cancelled_at": 1,
22       "request_counts": {
23         "total": 100,
24         "completed": 97,
25         "failed": 3
26       },
27       "metadata": {},
28       "errors": null
29     }
30   ],
31   "first_id": "string",
32   "last_id": "string",
33   "has_more": true
34 }

List batches from the selected provider using customer-owned credentials. The response is relayed in the provider’s OpenAI-compatible shape.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Query parameters

provider_idstringRequired

Provider route, for example openai or parasail.

afterstringOptional

Provider pagination cursor.

limitintegerOptional>=1

Maximum batches requested from the provider.

Response

OpenAI-compatible batch list.

objectenum

datalist of objects

first_idstring or nullOptional

last_idstring or nullOptional

has_morebooleanOptional

Errors

400

Bad Request Error

401

Unauthorized Error

424

Failed Dependency Error