文档中心

火山方舟

Files API

The file object

上传文件或检索文件后，模型会返回一个 file 对象。本文为您介绍 file 对象包含的详细参数。

object string

固定为file。

id string

文件的唯一标识符。

purpose string

文件用途。

scope object

文件所属作用域信息，用于标识该文件创建时归属的会话上下文。

属性

filename string

文件名。

tos object

文件存储的 TOS 信息。TOS 即火山引擎对象存储服务，仅当用户传入 tos 参数时才会返回。

属性

bytes integer

文件大小，以bytes为单位。

created_at integer

本次请求上传文件时的Unix时间戳(秒)。

expire_at integer

文件过期时间的Unix时间戳（秒）。

mime_type string

文件的MIME类型，如application/pdf。

status string

文件处理状态。

processing：文件正在预处理，无法使用。

active：文件已处理完成，可以使用。

failed：文件上传失败，错误详情查看 error 字段。

error object / null

文件上传失败时返回的错误对象，即 status 取值为failed时才会返回该字段。

code：错误码。

message：错误描述信息。

preprocess_configs object / null

用于设置不同文件类型的预处理规则。

属性

默认

发起调试等同于请求真实调用，可能产生云产品费用，请谨慎操作！

request

curl https://ark.cn-beijing.volces.com/api/v3/files \
-H "Authorization: Bearer $ARK_API_KEY" \
-F 'purpose=user_data' \
-F 'file=@/root/projects/ark/ark_image.png'

response

{
    "object": "file",
    "id": "file-20251014203036-24jvn",
    "purpose": "user_data",
    "filename": "demo.png",
    "bytes": 601,
    "mime_type": "image/png",
    "created_at": 1760445036,
    "expire_at": 1760704236,
    "status": "processing"
}

最近更新时间：2026.07.06 11:50:12

这个页面对您有帮助吗？

有用

无用