Delete a Message Batch
client.beta.messages.batches.delete(stringmessageBatchID, BatchDeleteParams { betas } params?, RequestOptionsoptions?): BetaDeletedMessageBatch { id, type }
/v1/messages/batches/{message_batch_id}?beta=true
Delete a Message Batch.
Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it.
Learn more about the Message Batches API in our user guide
Parameters
messageBatchID: string
ID of the Message Batch.
Returns
Delete a Message Batch
TypeScript
import Anthropic from '@anthropic-ai/sdk';
const client = new Anthropic({
apiKey: 'my-anthropic-api-key',
});
const betaDeletedMessageBatch = await client.beta.messages.batches.delete('message_batch_id');
console.log(betaDeletedMessageBatch.id);{
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"type": "message_batch_deleted"
}Returns Examples
{
"id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
"type": "message_batch_deleted"
}