List batch jobs with query filters

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/?status=completed&provider_id=openai" \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "count": 42,
3   "results": [
4     {
5       "id": "batch_9f8e7d6c5b4a3",
6       "provider_id": "openai",
7       "status": "completed",
8       "request_count": 150,
9       "completed_count": 147,
10       "failed_count": 3,
11       "total_cost": 2.5789,
12       "is_usage_tracked": true,
13       "is_active": false,
14       "is_terminal": true,
15       "created_at": "2024-04-10T08:15:30Z",
16       "updated_at": "2024-04-10T10:45:00Z",
17       "completed_at": "2024-04-10T10:44:59Z",
18       "last_polled_at": "2024-04-10T10:45:00Z",
19       "start_log_unique_id": "log_20240410_081530",
20       "completion_log_unique_id": "log_20240410_104459",
21       "provider_data": {
22         "input_file": "s3://respan-batches/input_20240410.json",
23         "endpoint": "https://api.openai.com/v1/batch/completions"
24       }
25     }
26   ],
27   "next": "https://api.respan.ai/api/v1/batches/list/?page=2&page_size=20",
28   "previous": null
29 }

Dashboard-authenticated POST-for-filtering route for batch jobs. The backend delegates POST to GET, so filters are query parameters (status, provider_id) and request bodies are ignored.

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptional>=1

Page number.

page_sizeintegerOptional1-100

Number of results per page. Maximum 100.

statusstringOptional

Filter dashboard batch jobs by normalized batch status.

provider_idstringOptional

Filter dashboard batch jobs by provider ID.

Response

Paginated filtered list of batch jobs.

countinteger

Total number of matching batch jobs.

resultslist of objects

nextstring or null

URL for the next page, if any.

previousstring or null

URL for the previous page, if any.

Errors

400

Bad Request Error

401

Unauthorized Error