ファイルとバッチ

バッチの取得

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

GET
/v1/batches/{batch_id}

概要

このエンドポイントは、TokenLabのOpenAI互換バッチAPIの一部です。バッチジョブはアップロードされたJSONLファイルを使用し、非同期で実行され、後で出力/エラーファイルを返すことができます。

注意事項

  • バッチ入力ファイルはpurpose=batchを使用する必要があります。
  • completion_windowは現在24hです。
  • 出力の順序は保証されていません。常にcustom_idで一致させてください。
  • バッチアイテム内でのストリーミングはサポートされていません。

例

リクエスト

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

リクエスト / レスポンス

正確なスキーマについては、上記のインタラクティブなOpenAPIパネルを使用してください。

操作のヒント

  • 冪等性のある下流の調整にはcustom_idを使用してください。
  • ワーカーがバッチを最終化した後にのみoutput_file_idとerror_file_idを期待してください。

レスポンス例

レスポンス

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
関連 API で使う file identifier です。
error_file_idstring|null
関連 API で使う file identifier です。

認証

BearerAuth
AuthorizationBearer <token>

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

場所: header

パスパラメータ

batch_id*string

レスポンス

application/json

application/json