ファイルとバッチ

バッチの作成

アップロードされたJSONLファイルからバッチを作成します。

POST
/v1/batches

概要

purpose=batch を指定してJSONLファイルをアップロードし、そのIDを input_file_id として使用します。完了したバッチは、出力ファイルIDとエラーファイルIDを返します。

入力ファイル

ファイルはJSONL形式です。1行につき1リクエストで、最大50,000行、200 MiBまでとなります。/v1/embeddings の場合、全行を通じた入力の合計数も50,000に制限されます。各行には以下が必要です。

  • custom_id: ファイル内で一意の文字列。
  • method: POST。
  • url: バッチの endpoint と同じ値。
  • body: model を含むリクエストボディ。
{"custom_id": "req-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-5.6-terra", "messages": [{"role": "user", "content": "Hello"}], "max_tokens": 100}}

注意事項

  • バッチ入力ファイルには purpose=batch を使用する必要があります。
  • completion_window は 24h であり、これがデフォルトかつ唯一の値です。
  • metadata には最大16個の文字列ペアを指定できます。キーは最大64文字、値は最大512文字です。
  • output_expires_after は結果ファイルの有効期限を設定します。anchor は created_at または completed_at で、seconds は最大30日です。
  • 出力順序は入力順序と異なる場合があります。各結果は custom_id で照合してください。
  • バッチアイテム内でのストリーミングはサポートされていません。
  • サポートされているアイテムエンドポイントは /v1/chat/completions および /v1/embeddings です。/v1/responses はサポートされていません。
  • バッチ作成時に推定コストが確保されます。残高が不足している場合は 402 が返されます。
  • 無効なファイルの場合、param に input_file_id が設定され、メッセージに該当行が示された状態で 400 が返されます。

例

リクエスト

cURL
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"
  }'

バッチの価格は同期リクエストと異なる場合があります。請求額については最終的な請求書をご確認ください。

レスポンス例

レスポンス

200 OK
{
  "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
}

重要なフィールド

idstring
バッチID。
statusstring
バッチのステータス。
output_file_idstring|null
完了後の出力ファイルID。

認証

BearerAuth
AuthorizationBearer <token>

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

場所: header

ヘッダー

X-TokenLab-Delivery-Policy?string

リクエストごとの配信ポリシー。APIキーおよびWorkspaceのデフォルト設定を上書きします。自動的にまず TokenLab Verified を試行し、出力、リクエストの受け入れ、または永続的なリソース作成の前に、一度だけ Official に切り替える場合があります。

指定できる値

  • "auto"
  • "verified"
  • "official"

リクエストボディ

application/json

レスポンス

application/json

application/json

application/json

application/json

application/json