Cancel batch

from cerebras.cloud.sdk import Cerebras
import os

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

batch = client.batches.cancel("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.cancel("batch_abc123");

  console.log(batch);
}

main();

curl --location --request DELETE '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": "calling",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1765492780,
    "in_progress_at": null,
    "expires_at": null,
    "finalizing_at": null,
    "completed_at": 1765493188,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": 1765492797,
    "cancelled_at":null,
    "request_counts": null,
    "metadata": null
}

DELETE

batches

{batch_id}

from cerebras.cloud.sdk import Cerebras
import os

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

batch = client.batches.cancel("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.cancel("batch_abc123");

  console.log(batch);
}

main();

curl --location --request DELETE '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": "calling",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1765492780,
    "in_progress_at": null,
    "expires_at": null,
    "finalizing_at": null,
    "completed_at": 1765493188,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": 1765492797,
    "cancelled_at":null,
    "request_counts": null,
    "metadata": null
}

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

Cancels a batch job that is currently queued or running. Completed requests remain saved in the results and can be retrieved through the retrieve batch endpoint.

Path Parameters

string

required

The ID of the batch job to cancel.

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 status of the batch job. Will be cancelling immediately after calling cancel. Once cancellation is complete (up to 10 minutes), the status changes to cancelled.

string | null

The ID of the file containing batch results with any completed requests.

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 | null

Statistics about the requests in the batch (if available).

object | null

Custom metadata associated with the batch job.

When you cancel an in-progress batch, it will be in cancelling status for up to 10 minutes before changing to cancelled, where it will have partial results (if any) available in the output file.

from cerebras.cloud.sdk import Cerebras
import os

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

batch = client.batches.cancel("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.cancel("batch_abc123");

  console.log(batch);
}

main();

curl --location --request DELETE '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": "calling",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1765492780,
    "in_progress_at": null,
    "expires_at": null,
    "finalizing_at": null,
    "completed_at": 1765493188,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": 1765492797,
    "cancelled_at":null,
    "request_counts": null,
    "metadata": null
}

List batch

Upload file

⌘I

Introduction

Chat

Completions

Models

Batch

Files

Metrics

Management

Path Parameters

Response

​Path Parameters

​Response

Path Parameters

Response