ファイルとバッチ

ファイルの一覧

アップロードされたファイルと、サポートされているファイルベースの互換モードを一覧表示します。

GET
/v1/files

概要

このエンドポイントは主に、アップロードされたバッチ入力ファイルと生成された出力/エラーファイルを含む、TokenLab の OpenAI 互換 Batch API を対象としています。

リクエストが Anthropic Files 互換モードを選ぶ場合、同じルートはバインドされたワークスペースで利用可能な Anthropic スタイルのファイルも一覧できます。

Anthropic ヘッダーがない場合、一覧にはバッチファイルと TokenLab の画像/参照ファイルの両方が含まれることがあります。purpose=batch、purpose=batch_output、purpose=user_data、purpose=vision で絞り込めます。

注意事項

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

例

リクエスト

cURL
curl -X GET "https://api.tokenlab.sh/v1/files?purpose=batch&limit=20" \
  -H "Authorization: Bearer sk-your-api-key"

リクエスト / レスポンス

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

操作のヒント

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

フィルター

  • バッチおよび画像参照ファイルの limit は 1–10000(デフォルト 10000)で、ページ送りには after を使います。Anthropic Files モードでは 1–1000(デフォルト 20)です。after_id または before_id のどちらか一方でページ送りします。
  • purpose は batch、batch_output、user_data、vision のいずれかです。
  • user_data と vision は、利用可能な場合に TokenLab が作成した画像参照ファイルを返します。

レスポンス例

レスポンス

200 OK
{
  "object": "list",
  "data": [{ "id": "file_abc123", "object": "file", "purpose": "batch" }],
  "first_id": "file_abc123",
  "last_id": "file_abc123",
  "has_more": false
}

重要フィールド

objectstring
レスポンスの object type です。
dataarray
このレスポンスで返されるリストまたは payload です。
has_moreboolean
has_more が true の場合、続きの結果があります。

認証

BearerAuth
AuthorizationBearer <token>

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

場所: header

クエリパラメータ

limit?integer
範囲1 <= value <= 1000
デフォルト20
after?string
after_id?string

Anthropic Filesカーソル。この公開ファイルID以降のファイルを返します。Anthropic Filesベータヘッダーが必要であり、before_idと組み合わせることはできません。

before_id?string

Anthropic Filesカーソル。この公開ファイルID以前のファイルを返します。Anthropic Filesベータヘッダーが必要であり、after_idと組み合わせることはできません。

scope_id?string

予約済みのAnthropic Filesスコープカーソル。TokenLabは現在、この値を黙って無視するのではなく、明示的な非サポートエラーを返します。

purpose?string

オプションのファイル目的フィルタ。batchおよびbatch_outputはBatch APIファイルをカバーし、user_dataおよびvisionはTokenLabの画像/参照ファイルバインディングをカバーします。Anthropic Files APIモードは、このクエリパラメータではなくAnthropicヘッダーによって選択されます。

指定できる値

  • "batch"
  • "batch_output"
  • "user_data"
  • "vision"

ヘッダー

anthropic-beta?string

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

レスポンス

application/json

application/json