跳转到主要内容

File 对象

上传、查询和列表接口都会返回 File 对象。
字段类型说明
file_idstringFile ID,前缀为 file_
filenamestring存储后的文件名
size_bytesinteger文件大小,单位 byte
mime_typestring上传时提供或根据文件名检测出的 MIME type
purposestring文件用途,见 File purpose
statusstring文件状态,见 File status
metadataJSON value上传时传入的 metadata JSON;省略时为 {}
created_atstringUTC 创建时间,RFC 3339 格式
updated_atstringUTC 更新时间;与 created_at 不同时返回
session_idstring文件关联 Session 时返回

File purpose

说明
user_upload用户上传并供后续使用的文件
tool_output工具生成的文件
skill_outputSkill 生成的文件
session_resource作为 Session resource 挂载的文件
agent_outputAgent 生成的输出文件

File status

说明
uploading文件记录已创建,内容上传中
ready文件内容可用
error文件记录创建后上传失败
deleted文件已删除;只有列表接口显式包含 deleted 文件时才会返回
GET /v1/files/{file_id}/content 返回该结构。
字段类型说明
urlstring预签名下载 URL
expires_atstringURL 的 UTC 过期时间,RFC 3339 格式

上传表单字段

POST /v1/files 使用 multipart/form-data
字段类型必填说明
filefile文本类文件内容
namestring存储文件名。不传时使用上传文件名。服务端清理后长度必须为 1-255 byte,且不能是 ...
purposestring默认 user_upload,见 File purpose
metadataJSON string作为表单字段传入的合法 JSON。原始长度最大 8 KB,省略时为 {}

支持上传的文件类型

上传接口只接受文本类文件。
类别支持的值
MIME type任意 text/* MIME type,以及 application/jsonapplication/xmlapplication/javascriptapplication/x-yamlapplication/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
无扩展名文件名dockerfilemakefilegemfilerakefileprocfilevagrantfilejustfilebrewfile

相关

附加与下载文件

上传文件为 Agent 提供上下文,并下载 Agent 产出的文件。