ファイルとバッチ

ファイルのアップロード

バッチファイル、画像参照ファイル、または Anthropic 形式のファイルをアップロードします。

POST
/v1/files

概要

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

サポートされるファイルモード

TokenLab は /v1/files を明確に 3 つのモードとして扱います:

  • バッチファイル: /v1/batches 用に purpose=batch を使います。
  • 画像/参照ファイル: ファイルベースの画像リクエスト用に purpose=user_data または purpose=vision を使います。
  • Anthropic Files API モード: Anthropic ネイティブのファイル保存には anthropic-beta: files-api-2025-04-14 を追加します。

注意事項

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

例

リクエスト

cURL
curl -X POST "https://api.tokenlab.sh/v1/files" \
  -H "Authorization: Bearer sk-your-api-key" \
  -F "purpose=batch" \
  -F "file=@batch-input.jsonl;type=application/jsonl"

リクエスト / レスポンス

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

操作のヒント

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

画像ファイル入力

同じ /v1/files ルートで /v1/images/edits 用の画像参照ファイルもアップロードできます。

  • purpose=user_data または purpose=vision を使用します。
  • 任意で model を指定して画像編集モデルを選択できます。デフォルトは gpt-image-2 です。
  • 返された file_id は選択した画像編集モデルの範囲で有効で、images[].file_id で再利用できます。

Anthropic Files API モード

この /v1/files ルートは Anthropic Files API にも対応しています。

  • anthropic-beta: files-api-2025-04-14 ヘッダーを追加すると、Anthropic モードに切り替わります。
  • Anthropic モードでは、元のファイルをそのままアップロードし、purpose=batch は送らないでください。
  • 返された file_id は同じ Anthropic 互換ワークスペースの範囲で有効で、以後の /v1/messages リクエストで再利用する必要があります。
  • Anthropic メッセージ内容からそのファイルを参照する場合は、Anthropic ネイティブのヘッダー(x-api-key、anthropic-version、必要に応じた beta header)をそのまま使ってください。

ファイルの有効期限

バッチ入力ファイルでは、必要に応じて expires_after[anchor]=created_at と expires_after[seconds] で有効期限ウィンドウを設定できます。秒数は 3600 から 2592000 の間で指定してください。

レスポンス例

レスポンス

200 OK
{
  "id": "file_abc123",
  "object": "file",
  "bytes": 32768,
  "created_at": 1706000000,
  "filename": "batch-input.jsonl",
  "purpose": "batch"
}

重要フィールド

idstring
関連 API で使う file identifier です。
purposestring
ファイルに割り当てられた purpose です。アップロードでは batch、user_data、vision を受け付けます。
bytesinteger
ファイルサイズ(バイト)です。

認証

BearerAuth
AuthorizationBearer <token>

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

場所: header

ヘッダー

anthropic-beta?string

Anthropic Files APIモードを使用するにはfiles-api-2025-04-14を含めてください。

リクエストボディ

multipart/form-data

レスポンス

application/json

application/json

application/json

application/json