Documentation ADE Guide Self-Hosting Letta Cloud API Reference Examples Leaderboard

Documentation ADE Guide Self-Hosting Letta Cloud API Reference Examples Leaderboard

API Reference
- API and SDK Overview
- Changelog
agents
models
- GETList LLM Models
- GETList Embedding Models
blocks
identities
tools
folders
jobs
runs
steps
groups
providers
Tags
- GETList Tags
Batches
voice
- POSTCreate Voice Chat Completions
health
- GETCheck Health
projects
- GETList Projects (Cloud-only)
templates
Client Side Access Tokens
telemetry
- GETRetrieve Provider Trace
sources
archives

Cancel Batch

PATCH

/v1/messages/batches/:batch_id/cancel

PATCH

/v1/messages/batches/:batch_id/cancel

1 from letta_client import Letta
2 
3 client = Letta(
4     base_url="https://api.letta.com",
5     token=
6 )
7 
8 client.batches.cancel(
9     batch_id="batch_id"
10 )

Cancel a batch run.

Path parameters

batch_idstringRequired

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Response

Successful Response

Errors

Was this page helpful?

List Messages For Batch