Delete a Message Batch

DELETE /v1/messages/batches/{message_batch_id}?beta=true

Copy endpoint

https://api.anthropic.com

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

Name	Type
`message_batch_id` required ID of the Message Batch.	string

Name	Type
`anthropic-beta` Optional header to specify the beta version(s) you want to use. To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.	string
`anthropic-version` The version of the Claude API you want to use. Read more about versioning and our version history here.	string
`x-api-key` Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the Console. Each key is scoped to a Workspace.	string

200 application/json

Successful Response

interface BetaDeleteMessageBatchResponse {
id: string;
type: "message_batch_deleted";
}

4XX application/json

Error response.

See our errors documentation for more details.

interface BetaErrorResponse {
error:

BetaInvalidRequestError

interface BetaInvalidRequestError {
message: string;
type: "invalid_request_error";
}

BetaAuthenticationError

interface BetaAuthenticationError {
message: string;
type: "authentication_error";
}

BetaBillingError

interface BetaBillingError {
message: string;
type: "billing_error";
}

BetaPermissionError

interface BetaPermissionError {
message: string;
type: "permission_error";
}

BetaNotFoundError

interface BetaNotFoundError {
message: string;
type: "not_found_error";
}

BetaRateLimitError

interface BetaRateLimitError {
message: string;
type: "rate_limit_error";
}

BetaGatewayTimeoutError

interface BetaGatewayTimeoutError {
message: string;
type: "timeout_error";
}

BetaAPIError

interface BetaAPIError {
message: string;
type: "api_error";
}

BetaOverloadedError

interface BetaOverloadedError {
message: string;
type: "overloaded_error";
}

;
request_id: string | null;
type: "error";
}