inferenceClient.batches.list()

Generated on 13 Nov 2026 from DoTs version v1.24.0

Usage

inferenceClient.batches.list(query?: Record<string, any>): Promise<any>

Description

Returns a cursor-paginated list of batch jobs, ordered newest first. Use limit to control page size and after to page forward using the last_id from the previous response.

Parameters

after string optional

Example: 7b2e9c1a-6f4d-4d9b-a0f1-5c4b7e2f8a12

Cursor for pagination. Pass the last_id value from the previous response to fetch the next page. Omit for the first page.

limit integer optional

Example: 20

Maximum number of batches to return per page.

Default: 20

Min: 1

Max: 100

status string optional

Optional filter restricting results to batches in the given lifecycle state.

One of: validating, in_progress, finalizing, completed, failed, expired, cancelling, cancelled

Request Sample

Show Request Sample
import { InferenceClient } from "@digitalocean/dots";

const inferenceClient = new InferenceClient({
    apiKey: process.env.MODEL_ACCESS_KEY!,
});

const response = await inferenceClient.batches.list();

Response Example

Show Response Example
{
  "object": "list",
  "data": [
    {
      "batch_id": "0e9d1d35-3d1e-4d66-9a2f-8c7e0f6b3e21",
      "status": "in_progress",
      "provider": "openai",
      "endpoint": "/v1/chat/completions",
      "completion_window": "24h",
      "input_file_id": "a1b2c3d4-e5f6-4789-90ab-cdef12345678",
      "output_file_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "error_file_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "request_id": "c7e3ad1e-20c3-4e47-9bf2-6f2a4d6a2f11",
      "errors": [],
      "created_at": "2026-04-24T19:19:19Z",
      "in_progress_at": "2026-04-24T19:20:05Z",
      "finalizing_at": "2026-04-24T20:10:42Z",
      "completed_at": "2026-04-24T20:15:30Z",
      "expires_at": "2026-04-25T19:19:19Z",
      "cancelled_at": "2026-04-24T19:45:11Z",
      "failed_at": "2026-04-24T19:50:00Z"
    }
  ],
  "first_id": "0e9d1d35-3d1e-4d66-9a2f-8c7e0f6b3e21",
  "last_id": "7b2e9c1a-6f4d-4d9b-a0f1-5c4b7e2f8a12",
  "has_more": false
}

More Information

See /v1/batches in the API reference for additional detail on responses, headers, parameters, and more.

We can't find any results for your search.

Try using different keywords or simplifying your search terms.