API Reference

Batches

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Cancel Batch

batches.cancel(strbatch_id) -> object

patch/v1/messages/batches/{batch_id}/cancel

Cancel a batch run.

ParametersExpand Collapse

batch_id: str

ReturnsExpand Collapse

object

Cancel Batch

Python

• HTTP
• TypeScript
• Python

from letta_client import Letta

client = Letta(
    api_key="My API Key",
)
response = client.batches.cancel(
    "batch_id",
)
print(response)

200 example

{}

Returns Examples

200 example

{}