Cancel Batch

client.batches.cancel(, ?): BatchCancelResponse

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

Cancel a batch run.

ParametersExpand Collapse

batchID: string

ReturnsExpand Collapse

BatchCancelResponse = unknown

Cancel Batch

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

const client = new Letta({
  apiKey: process.env['LETTA_API_KEY'], // This is the default and can be omitted
});

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

console.log(response);

{}

Returns Examples

{}