ファイルとバッチ
Retrieve Message Batch
Message Batchのステータスとリクエスト数を取得します。
概要
組織が作成したMessage Batchのステータス、リクエスト数、およびタイムスタンプを返します。processing_status が ended になるまでこのエンドポイントをポーリングし、その後 結果を取得 してください。
注意事項
processing_statusはin_progress、canceling、またはendedです。results_urlは、バッチが終了するまでnullとなります。- 存在しないバッチや削除されたバッチに対しては
404が返されます。まだ読み取り準備ができていないバッチに対しては409が返される場合があるため、後で再試行してください。
リクエスト
curl -X GET "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123" \
-H "x-api-key: sk-your-api-key" \
-H "anthropic-version: 2023-06-01"レスポンス
{
"id": "msgbatch_01ABC123",
"type": "message_batch",
"processing_status": "ended",
"request_counts": {
"processing": 0,
"succeeded": 2,
"errored": 0,
"canceled": 0,
"expired": 0
},
"ended_at": "2026-11-01T10:20:00Z",
"created_at": "2026-11-01T10:00:00Z",
"expires_at": "2026-11-02T10:00:00Z",
"cancel_initiated_at": null,
"archived_at": null,
"results_url": "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/results"
}重要なフィールド
processing_statusstring
in_progress、canceling、または ended。request_countsobject
processing、succeeded、errored、canceled、または expired の各リクエスト数。ended_atstring|null
処理が終了した日時、または
null。cancel_initiated_atstring|null
キャンセルリクエストが受け付けられた日時、または
null。results_urlstring|null
結果のURL、または
null。認証
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