跳转到主要内容
GET
/
v1
/
files
/
{file_id}
获取文件信息
curl --request GET \
  --url https://api.moonshot.cn/v1/files/{file_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "file",
  "bytes": 123,
  "created_at": 123,
  "filename": "<string>",
  "purpose": "file-extract",
  "status": "ok",
  "status_details": "<string>"
}
client.files.retrieve(file_id=file_id)
# FileObject(
#     id='clg681objj8g9m7n4je0',
#     bytes=761790,
#     created_at=1700815879,
#     filename='xlnet.pdf',
#     object='file',
#     purpose='file-extract',
#     status='ok', status_details='')

授权

​
Authorization
string
header
必填

Authorization 请求头需要一个 Bearer 令牌。使用 MOONSHOT_API_KEY 作为令牌。这是一个服务端密钥，请在 API 密钥页面 生成。

路径参数

​
file_id
string
必填

文件标识符

响应

文件元数据

​
id
string
必填

文件唯一标识符

​
object
string
必填

对象类型

示例:

"file"

​
bytes
integer
必填

文件大小（字节）

​
created_at
integer
必填

文件创建时的 Unix 时间戳

​
filename
string
必填

原始文件名

​
purpose
enum<string>
必填

上传文件时指定的用途。file-extract：抽取文件内容；image：上传图片，用于视觉理解；video：上传视频，用于视频理解

可用选项:
file-extract,
image,
video
​
status
string
必填

文件处理状态

示例:

"ok"

​
status_details
string

处理失败或返回警告时的额外状态详情