API Reference

Batches

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Cancel Batch

client.batches.cancel(stringbatchID, RequestOptionsoptions?): BatchCancelResponse

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

Cancel a batch run.

ParametersExpand Collapse

batchID: string

ReturnsExpand Collapse

BatchCancelResponse = unknown

Cancel Batch

TypeScript

• HTTP
• TypeScript
• Python

import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: 'My API Key',
});

const response = await client.batches.cancel('batch_id');

console.log(response);

200 example

{}

Returns Examples

200 example

{}