File オブジェクト
upload、get、list エンドポイントで File オブジェクトが返却されます。| フィールド | 型 | 説明 |
|---|---|---|
file_id | string | file_ プレフィックス付きの File ID |
filename | string | 保存されたファイル名 |
size_bytes | integer | ファイルサイズ（バイト） |
mime_type | string | アップロード時に指定された、またはファイル名から検出された MIME タイプ |
purpose | string | ファイルの用途。ファイル用途を参照 |
status | string | ファイルのステータス。ファイルステータスを参照 |
metadata | JSON 値 | アップロード時に指定されたメタデータ JSON。デフォルトは {} |
created_at | string | RFC 3339 形式の UTC 作成時刻 |
updated_at | string | UTC 更新時刻、created_at と異なる場合のみ返却 |
session_id | string | ファイルが Session に関連付けられている場合に返却 |
ファイル用途
| 値 | 説明 |
|---|---|
user_upload | ユーザーが後で使用するためにアップロードしたファイル |
tool_output | ツールによって生成されたファイル |
skill_output | Skill によって生成されたファイル |
session_resource | Session リソースとしてアタッチされたファイル |
agent_output | Agent の出力として生成されたファイル |
ファイルステータス
| 値 | 説明 |
|---|---|
uploading | アップロードレコードが作成され、コンテンツのアップロードが進行中 |
ready | ファイルコンテンツが利用可能 |
error | レコード作成後にアップロードが失敗 |
deleted | ファイルが削除済み。削除済みファイルを明示的に含むリストリクエストでのみ返却 |
ファイルコンテンツリンク
GET /v1/files/{file_id}/content はこのオブジェクトを返します。
| フィールド | 型 | 説明 |
|---|---|---|
url | string | 署名付きダウンロード URL |
expires_at | string | RFC 3339 形式の UTC での URL 有効期限 |
アップロードフォームフィールド
POST /v1/files は multipart/form-data を使用します。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
file | file | はい | テキストベースのファイルコンテンツ |
name | string | いいえ | 保存されるファイル名。デフォルトはアップロードされたファイル名。サーバーのサニタイズ後、長さは 1-255 バイトで、. または .. は使用できません |
purpose | string | いいえ | デフォルトは user_upload。ファイル用途を参照 |
metadata | JSON string | いいえ | フォームフィールドとしてエンコードされた有効な JSON。最大生データ長は 8 KB。デフォルトは {} |
サポートされるアップロードファイルタイプ
アップロードエンドポイントはテキストベースのファイルのみを受け付けます。| カテゴリ | 受け入れ可能な値 |
|---|---|
| MIME タイプ | すべての text/* MIME タイプに加え、application/json、application/xml、application/javascript、application/x-yaml、application/x-toml |
| 拡張子 | .txt, .md, .csv, .json, .xml, .yaml, .yml, .toml, .ini, .conf, .cfg, .env, .log, .html, .htm, .css, .scss, .less, .js, .jsx, .ts, .tsx, .vue, .svelte, .py, .go, .rs, .java, .kt, .scala, .c, .cpp, .cc, .h, .hpp, .rb, .php, .swift, .r, .lua, .pl, .sh, .bash, .zsh, .fish, .ps1, .sql, .graphql, .gql, .proto, .dockerfile, .makefile, .gitignore, .editorconfig, .eslintrc, .prettierrc, .tex, .rst, .adoc, .org, .svg |
| 拡張子なしファイル名 | dockerfile, makefile, gemfile, rakefile, procfile, vagrantfile, justfile, brewfile |
関連項目
ファイルの添付とダウンロード
Agent にコンテキストを提供するファイルをアップロードし、Agent が生成したファイルをダウンロードします。