Filter Batch Jobs

POST

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

POST

/api/v1/batches/list/

$ curl -X POST https://api.respan.ai/api/v1/batches/list/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "id": "string",
>   "provider_id": "string",
>   "start_log_unique_id": "string"
> }'

201Created

1 {
2   "id": "string",
3   "provider_id": "string",
4   "is_usage_tracked": "string",
5   "is_active": "string",
6   "is_terminal": "string",
7   "created_at": "2024-01-15T09:30:00Z",
8   "updated_at": "2024-01-15T09:30:00Z",
9   "start_log_unique_id": "string",
10   "status": "pending",
11   "request_count": 1,
12   "completed_count": 1,
13   "failed_count": 1,
14   "total_cost": 1.1,
15   "completed_at": "2024-01-15T09:30:00Z",
16   "last_polled_at": "2024-01-15T09:30:00Z",
17   "completion_log_unique_id": "string",
18   "provider_data": null
19 }

POST for filtering (not creation) - delegate to GET.

Authentication

AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Request

This endpoint expects an object.

idstringRequired1-255 characters

Provider’s batch ID (e.g., batch_…)

provider_idstringRequired1-50 characters

Provider ID matching litellm_provider_id (e.g., ‘openai’, ‘parasail’)

start_log_unique_idstringRequired1-255 characters

unique_id of the start log (log_type=BATCH)

statusenumOptional

Batch job status (OpenAI-compatible)

pending - Pending
validating - Validating
in_progress - In Progress
finalizing - Finalizing
completed - Completed
failed - Failed
cancelling - Cancelling
cancelled - Cancelled
expired - Expired

request_countintegerOptional-2147483648-2147483647

completed_countintegerOptional-2147483648-2147483647

failed_countintegerOptional-2147483648-2147483647

total_costdoubleOptional

Total cost calculated from output (populated on completion)

completed_atdatetime or nullOptional

When batch reached terminal status

last_polled_atdatetime or nullOptional

Last time status was polled (for smart backoff)

completion_log_unique_idstringOptional<=255 characters

unique_id of the completion log (populated when status=completed and logged)

provider_dataanyOptional

Provider metadata (input_file_id, endpoint, etc.)

Response

idstring<=255 characters