ファイルとバッチ

メッセージバッチの削除

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

DELETE
/v1/messages/batches/{message_batch_id}

概要

終了したメッセージバッチを削除します。削除後、そのバッチはリストに表示されなくなり、ステータスや結果も取得できなくなります(404)。

注意事項

  • バッチが終了し、TokenLabによる利用料金の確定が完了した後にのみ削除してください。それ以前にリクエストを行うと、エラータイプ conflict_error を伴う 409 が返されます。処理中のバッチを削除したい場合は、まずキャンセルし、終了するまで待機してから削除してください。
  • 削除を行っても、請求内容には影響しません。
  • バッチを削除する前に、結果をダウンロードしてください。

例

リクエスト

cURL
curl -X DELETE "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01"

レスポンス例

レスポンス

200 OK
{
  "id": "msgbatch_01ABC123",
  "type": "message_batch_deleted"
}

重要なフィールド

idstring
削除されたバッチのID。
typestring
常に message_batch_deleted となります。

認証

BearerAuth
AuthorizationBearer <token>

APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。

場所: header

パスパラメータ

message_batch_id*string

メッセージバッチ識別子

レスポンス

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json