Cancel Batch

batches.cancel() -> object

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

Cancel a batch run.

ParametersExpand Collapse

batch_id: str

ReturnsExpand Collapse

object

Cancel Batch

import os
from letta_client import Letta

client = Letta(
    api_key=os.environ.get("LETTA_API_KEY"),  # This is the default and can be omitted
)
response = client.batches.cancel(
    "batch_id",
)
print(response)

{}

Returns Examples

{}