ファイルとバッチ

ファイルの取得

単一のアップロード済みファイルのメタデータを取得します。

GET
/v1/files/{file_id}

概要

このエンドポイントは主に、TokenLab の OpenAI 互換 Batch API ファイルオブジェクトを対象としています。

リクエストが Anthropic Files 互換モードを選ぶ場合、同じルートはバインドされたワークスペース向けの Anthropic スタイルのファイルメタデータも返せます。

Anthropic ヘッダーがない場合、このルートはバッチファイルオブジェクトまたは TokenLab の画像/参照ファイルオブジェクトを返します。

注意事項

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

例

リクエスト

cURL
curl -X GET "https://api.tokenlab.sh/v1/files/file_abc123" \
  -H "Authorization: Bearer sk-your-api-key"

リクエスト / レスポンス

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

操作のヒント

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

画像参照ファイル

このエンドポイントは、TokenLab が作成した画像参照ファイルのメタデータも返せます。status フィールドは任意であり、ファイル種別によっては存在しない場合があります。

レスポンス例

レスポンス

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

重要フィールド

idstring
関連 API で使う file identifier です。
filenamestring
元のファイル名または生成されたファイル名です。
purposestring
所有するワークフローで使われるファイル purpose です。例: batch、batch_output、user_data、vision。

認証

BearerAuth
AuthorizationBearer <token>

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

場所: header

パスパラメータ

file_id*string

ヘッダー

anthropic-beta?string

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

レスポンス

application/json

application/json