メッセージバッチを削除

DELETE/v1/messages/batches/{message_batch_id}

メッセージバッチを削除します。

メッセージバッチは処理が完了した後にのみ削除できます。進行中のバッチを削除したい場合は、まずキャンセルする必要があります。

Message Batches APIの詳細については、ユーザーガイドをご覧ください。

Path parameters

message_batch_id: string

ID of the Message Batch.

Returns

DeletedMessageBatch object{ id, type }

id: string

ID of the Message Batch.

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted

メッセージバッチを削除

curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID \
    -X DELETE \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

Response 200

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}

Returns Examples

Response 200

{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "type": "message_batch_deleted"
}