Retrieve batch

from cerebras.cloud.sdk import Cerebras
import os

client = Cerebras(
    api_key=os.environ.get("CEREBRAS_API_KEY"),
)

batch = client.batches.retrieve("batch_abc123")

print(batch)

import Cerebras from '@cerebras/cerebras_cloud_sdk';

const client = new Cerebras({
  apiKey: process.env['CEREBRAS_API_KEY'],
});

async function main() {
  const batch = await client.batches.retrieve("batch_abc123");

  console.log(batch);
}

main();

curl --location 'https://api.cerebras.ai/v1/batches/batch_abc123' \
--header "Authorization: Bearer ${CEREBRAS_API_KEY}"

{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file_abc123",
  "completion_window": "24h",
  "status": "in_progress",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1766003277,
  "in_progress_at": 1766003300,
  "expires_at": 1766089677,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 75,
    "failed": 2
  },
  "metadata": {
    "custom_tags": ["legal-review", "q3"]
  }
}

GET

batches

{batch_id}

from cerebras.cloud.sdk import Cerebras
import os

client = Cerebras(
    api_key=os.environ.get("CEREBRAS_API_KEY"),
)

batch = client.batches.retrieve("batch_abc123")

print(batch)

import Cerebras from '@cerebras/cerebras_cloud_sdk';

const client = new Cerebras({
  apiKey: process.env['CEREBRAS_API_KEY'],
});

async function main() {
  const batch = await client.batches.retrieve("batch_abc123");

  console.log(batch);
}

main();

curl --location 'https://api.cerebras.ai/v1/batches/batch_abc123' \
--header "Authorization: Bearer ${CEREBRAS_API_KEY}"

{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file_abc123",
  "completion_window": "24h",
  "status": "in_progress",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1766003277,
  "in_progress_at": 1766003300,
  "expires_at": 1766089677,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 75,
    "failed": 2
  },
  "metadata": {
    "custom_tags": ["legal-review", "q3"]
  }
}

This feature is in Private Preview. For access or more information, contact us or reach out to your account representative.

Retrieves the status and progress of a batch job. Use this endpoint to monitor your batch job as it processes.

Path Parameters

string

required

The ID of the batch job to retrieve.

Response

string

A unique identifier for the batch job.

string

The object type, which is always batch.

string

The API endpoint used for batch processing.

object | null

Information about any errors that occurred during batch processing.

string

The ID of the input file containing batch requests.

string

The time window for batch completion. Always 24h.

string

The current status of the batch job. Possible values: validating, queued, in_progress, finalizing, completed, expired, failed, cancelled, cancelling.

string | null

The ID of the file containing batch results (available once processing is complete).

string | null

The ID of the file containing errors (if any errors occurred).

integer

The Unix timestamp (in seconds) of when the batch job was created.

integer | null

The Unix timestamp (in seconds) of when the batch job started processing.

integer | null

The Unix timestamp (in seconds) of when the batch job will expire.

integer | null

The Unix timestamp (in seconds) of when the batch job started finalizing.

integer | null

The Unix timestamp (in seconds) of when the batch job completed.

integer | null

The Unix timestamp (in seconds) of when the batch job failed.

integer | null

The Unix timestamp (in seconds) of when the batch job expired.

integer | null

The Unix timestamp (in seconds) of when the batch job started cancelling.

integer | null

The Unix timestamp (in seconds) of when the batch job was cancelled.

object

Statistics about the requests in the batch.

Show request_counts properties

integer

Total number of requests in the batch.

integer

Number of requests that completed successfully.

integer

Number of requests that failed.

object | null

Custom metadata associated with the batch job.

from cerebras.cloud.sdk import Cerebras
import os

client = Cerebras(
    api_key=os.environ.get("CEREBRAS_API_KEY"),
)

batch = client.batches.retrieve("batch_abc123")

print(batch)

import Cerebras from '@cerebras/cerebras_cloud_sdk';

const client = new Cerebras({
  apiKey: process.env['CEREBRAS_API_KEY'],
});

async function main() {
  const batch = await client.batches.retrieve("batch_abc123");

  console.log(batch);
}

main();

curl --location 'https://api.cerebras.ai/v1/batches/batch_abc123' \
--header "Authorization: Bearer ${CEREBRAS_API_KEY}"

{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file_abc123",
  "completion_window": "24h",
  "status": "in_progress",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1766003277,
  "in_progress_at": 1766003300,
  "expires_at": 1766089677,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 75,
    "failed": 2
  },
  "metadata": {
    "custom_tags": ["legal-review", "q3"]
  }
}

Create batch

List batch

⌘I

Introduction

Chat

Completions

Models

Batch

Files

Metrics

Management

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response