ファイルとバッチ

バッチの作成

アップロードされた入力ファイルからOpenAI互換のバッチジョブを作成します。

POST
/v1/batches

概要

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

注意事項

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

例

リクエスト

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

リクエスト / レスポンス

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

操作のヒント

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

レスポンス例

レスポンス

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
後続呼び出しとサポート調査に使う識別子です。
statusstring
このリソースの現在のライフサイクル状態です。
output_file_idstring|null
関連 API で使う file identifier です。

認証

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