List Batches

GET https://api.neosantara.xyz/v1/batches

List Batches

cURL

curl --request GET \
  --url https://api.neosantara.xyz/v1/batches \
  --header 'x-api-key: <api-key>'

200

{
  "object": "<string>",
  "data": [
    {
      "id": "<string>",
      "object": "<string>",
      "endpoint": "<string>",
      "errors": {},
      "input_file_id": "<string>",
      "completion_window": "<string>",
      "status": "<string>",
      "output_file_id": {},
      "error_file_id": {},
      "created_at": 123,
      "in_progress_at": {},
      "expires_at": 123,
      "finalizing_at": {},
      "completed_at": {},
      "failed_at": {},
      "expired_at": {},
      "cancelled_at": {},
      "request_counts": {},
      "metadata": {}
    }
  ],
  "first_id": {},
  "last_id": {},
  "has_more": true
}

List all batch jobs for the authenticated user, ordered by creation time (newest first).

limit · integer · default: "20"

The maximum number of batches to return. The API may return fewer batches than the specified limit.

after · string

A cursor for pagination. Use the ID of the last batch from the previous page to get the next page of results.

Returns

object · string

The object type, which is always list.

data · array

An array of batch objects.

Show batch object properties

id · string

The unique identifier of the batch.

object · string

The object type, always batch.

endpoint · string

The API endpoint used for the batch.

errors · object or null

Any errors encountered.

input_file_id · string

The input file ID.

completion_window · string

The completion time window.

status · string

The current batch status.

output_file_id · string or null

The output file ID if available.

error_file_id · string or null

The error file ID if available.

created_at · integer

Unix timestamp of creation.

in_progress_at · integer or null

Unix timestamp when processing started.

expires_at · integer

Unix timestamp of expiration.

finalizing_at · integer or null

Unix timestamp when finalizing started.

completed_at · integer or null

Unix timestamp of completion.

failed_at · integer or null

Unix timestamp of failure.

expired_at · integer or null

Unix timestamp of expiration.

cancelled_at · integer or null

Unix timestamp of cancellation.

request_counts · object

Request statistics.

metadata · object

Custom metadata.

first_id · string or null

The ID of the first batch in the list, useful for pagination.

last_id · string or null

The ID of the last batch in the list, useful for pagination.

has_more · boolean

Indicates whether there are more batches available beyond this page.

Response 200

{
  "object": "list",
  "data": [
    {
      "id": "batch-abc123",
      "object": "batch",
      "endpoint": "/v1/chat/completions",
      "errors": null,
      "input_file_id": "file-xyz789",
      "completion_window": "24h",
      "status": "completed",
      "output_file_id": "file-output-123",
      "error_file_id": "file-errors-456",
      "created_at": 1699564800,
      "in_progress_at": 1699565000,
      "expires_at": 1699651200,
      "finalizing_at": 1699568000,
      "completed_at": 1699568500,
      "failed_at": null,
      "expired_at": null,
      "cancelled_at": null,
      "request_counts": {
        "total": 100,
        "completed": 98,
        "failed": 2
      },
      "metadata": {
        "project": "data-analysis"
      }
    },
    {
      "id": "batch-def456",
      "object": "batch",
      "endpoint": "/v1/embeddings",
      "errors": null,
      "input_file_id": "file-abc999",
      "completion_window": "24h",
      "status": "in_progress",
      "output_file_id": null,
      "error_file_id": null,
      "created_at": 1699550000,
      "in_progress_at": 1699550200,
      "expires_at": 1699636400,
      "finalizing_at": null,
      "completed_at": null,
      "failed_at": null,
      "expired_at": null,
      "cancelled_at": null,
      "request_counts": {
        "total": 50,
        "completed": 30,
        "failed": 0
      },
      "metadata": {}
    }
  ],
  "first_id": "batch-abc123",
  "last_id": "batch-def456",
  "has_more": false
}