上传文件
POST/files
上传图片文件,之后可在对话补全请求中通过其 file_id 引用。
支持的格式:JPEG、PNG、GIF、WebP。格式由文件内容判断。详见 Files API 指南。
上传文档时,把 purpose 设为 text_recognition 或 rich_layout_recognition,并放在 file 字段之前。详见 文件解析指南。
Request
- multipart/form-data
Body
required
Possible values: user_data, text_recognition, rich_layout_recognition
上传文件的用途。上传文档时,请把该字段放在 file 之前。各用途支持的文件类型见 Files API 指南。
要上传的文件。可上传的文件类型取决于 purpose。
Possible values: created_at
过期时间的锚点。若提供,必须为 created_at,且需与 expires_after[seconds] 一起使用。
Possible values: >= 3600 and <= 2592000
文件的有效期(秒),取值在 3600(1 小时)到 2592000(30 天)之间。需与 expires_after[anchor] 一起使用。不传这两个 expires_after 字段则文件永久有效。
Responses
- 200
OK, 返回上传的 file object。
- application/json
- Schema
- Example
Schema
文件标识符,形如 file-api-...,可在对话补全请求中引用。
Possible values: file
对象的类型,其值为 file。
文件大小(字节)。
文件创建时的 Unix 时间戳(以秒为单位)。
文件名。
Possible values: user_data, text_recognition, rich_layout_recognition
文件的用途。
文件过期时的 Unix 时间戳(以秒为单位)。仅在上传时设置了过期时间才会出现。
{
"id": "file-api-0a1b2c3d4e5f60718293a4b5c6d7e8f9",
"object": "file",
"bytes": 102400,
"created_at": 1700000000,
"filename": "image.jpg",
"purpose": "user_data"
}