メインコンテンツへスキップ

​
概要

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

​
注意事項

  • バッチ入力ファイルはpurpose=batchを使用する必要があります。
  • completion_windowは現在24hです。
  • 出力の順序は保証されていません。常にcustom_idで一致させてください。
  • バッチアイテム内でのストリーミングはサポートされていません。
  • 現在サポートされているバッチアイテムのエンドポイントは /v1/chat/completions と /v1/embeddings です。ネイティブの Responses バッチ executor が利用可能になるまで、/v1/responses のバッチジョブは拒否されます。

​
例

curl -X POST "https://api.tokenlab.sh/v1/batches" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "input_file_id": "file_abc123",
    "endpoint": "/v1/chat/completions",
    "completion_window": "24h"
  }'

​
リクエスト / レスポンス

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

​
操作のヒント

  • 冪等性のある下流の調整にはcustom_idを使用してください。
  • ワーカーがバッチを最終化した後にのみoutput_file_idとerror_file_idを期待してください。
  • バッチの価格は、isBatchRequest=trueの割引ルールが適用されるため、同期価格とは異なる場合があります。

​
レスポンス例

{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "input_file_id": "file_abc123",
  "completion_window": "24h",
  "status": "validating",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1706000000
}

​
重要フィールド

​
id
string
後続呼び出しとサポート調査に使う識別子です。
​
status
string
このリソースの現在のライフサイクル状態です。
​
output_file_id
string|null
関連 API で使う file identifier です。