Cancel a batch job

Cancel a batch job by ID

POST /batches/{id}/cancel

Python

Together AI SDK (v2)

# Docs for v1 can be found by changing the above selector ^
from together import Together
import os

client = Together(
    api_key=os.environ.get("TOGETHER_API_KEY"),
)

batch = client.batches.cancel("batch_id")

print(batch)

200

{
  "id": "01234567-8901-2345-6789-012345678901",
  "user_id": "user_789xyz012",
  "input_file_id": "file-input123abc456def",
  "file_size_bytes": 1048576,
  "status": "IN_PROGRESS",
  "job_deadline": "2024-01-15T15:30:00Z",
  "created_at": "2024-01-15T14:30:00Z",
  "endpoint": "/v1/chat/completions",
  "progress": 75,
  "model_id": "Qwen/Qwen3.5-9B",
  "output_file_id": "file-output789xyz012ghi",
  "error_file_id": "file-errors456def789jkl",
  "error": "<string>",
  "completed_at": "2024-01-15T15:45:30Z"
}

Authorizations

Authorization · string · header · default: default · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The ID of the batch job to cancel

Example:

"batch_job_abc123def456"

Response

200

application/json

OK

id · string<uuid>

Example:

"01234567-8901-2345-6789-012345678901"

user_id · string

Example:

"user_789xyz012"

input_file_id · string

Example:

"file-input123abc456def"

file_size_bytes · integer<int64>

Size of input file in bytes

Example:

1048576

status · enum<string>

Current status of the batch job

Available options: VALIDATING, IN_PROGRESS, COMPLETED, FAILED, EXPIRED, CANCELLED

Example:

"IN_PROGRESS"

job_deadline · string<date-time>

Example:

"2024-01-15T15:30:00Z"

created_at · string<date-time>

Example:

"2024-01-15T14:30:00Z"

endpoint · string

Example:

"/v1/chat/completions"

progress · number<float64>

Completion progress (0.0 to 100)

Example:

75

model_id · string

Model used for processing requests

Example:

"Qwen/Qwen3.5-9B"

output_file_id · string

Example:

"file-output789xyz012ghi"

error_file_id · string

Example:

"file-errors456def789jkl"

error · string

completed_at · string<date-time>

Example:

"2024-01-15T15:45:30Z"