ファイルとバッチ

バッチの取得

バッチの現在のステータス、カウント、および結果ファイルを取得します。

GET
/v1/batches/{batch_id}

概要

バッチのステータス、完了および失敗したリクエストの数、結果ファイルのIDを返します。

例

リクエスト

cURL
curl -X GET "https://api.tokenlab.sh/v1/batches/batch_abc123" \
  -H "Authorization: Bearer sk-your-api-key"

レスポンス例

レスポンス

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "completed",
  "input_file_id": "file_abc123",
  "output_file_id": "file_out123",
  "error_file_id": "file_err123",
  "request_counts": { "total": 100, "completed": 98, "failed": 2 }
}

重要なフィールド

request_countsobject
合計、完了、失敗、およびキャンセルされたリクエストの数。
output_file_idstring|null
成功した結果ファイルのID。
error_file_idstring|null
失敗した結果ファイルのID。

認証

BearerAuth
AuthorizationBearer <token>

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

場所: header

パスパラメータ

batch_id*string

レスポンス

application/json

application/json