One change
Delete a Message Batch
api/messages/batches/delete
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/messages/batches/delete Changed · +9 / -14 lines
# Delete a Message Batch ## Path parameters ## Returns ## Example ### Response (200) ## Delete a Message Batch ### Path Parameters ### Returns ### Example #### Response
from line 1
---- -title: Delete a Message Batch -url: https://platform.claude.com/docs/en/api/messages/batches/delete ---- +# Delete a Message Batch -## Delete a Message Batch +**DELETE** `/v1/messages/batches/{message_batch_id}` -**delete** `/v1/messages/batches/{message_batch_id}` - 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.
from line 8
Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing) -### Path Parameters +## Path parameters - `message_batch_id: string` ID of the Message Batch. -### Returns +## Returns -- `DeletedMessageBatch object { id, type }` +- `DeletedMessageBatch object` - `id: string`
from line 28
For Message Batches, this is always `"message_batch_deleted"`. - - `"message_batch_deleted"` + default: message_batch_deleted -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \
from line 39
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +### Response (200) ```json {