上传图片
从源码生成 POST /files 的鉴权、字段、响应、错误与安全调用参考。
本页目录
操作
POST /files
operationId: create_file_v1_files_post
用 multipart 的 file 字段上传 PNG、JPEG 或 WebP,返回可复用公共文件 ID。服务校验实际图片字节与尺寸,不启动生成。上传不是幂等付费创建,传输异常后不要盲目重放。
鉴权与副作用
使用可信环境中的 Bearer API Key。所需权限:animations:write
此操作不启动付费生成,其他状态变化见上文说明。
参数
无路径、查询或操作专属请求头参数。
请求体 (multipart/form-data)
请求体必填:true
| 字段 | 类型 | 必填 | 默认值 | 约束 | 含义 |
|---|---|---|---|---|---|
file |
string |
是 | — | format: binary |
PNG、JPEG 或 WebP 图片字节,校验后返回公共文件 ID。 |
完整嵌套结构:Body_create_file_v1_files_post
响应
| HTTP | 正文 | 含义 |
|---|---|---|
201 |
FileResponse | 成功的公开响应,示例数值仅用于说明。 |
400 |
APIErrorEnvelope | 输入错误,修正请求后再尝试。 |
401 |
APIErrorEnvelope | API Key 缺失、到期或被撤销。 |
403 |
APIErrorEnvelope | 账户资格、账户状态或 Key 权限不允许此操作。 |
404 |
APIErrorEnvelope | 资源不可用、不属于当前用户,或签名无效/过期。 |
413 |
APIErrorEnvelope | 请求或解码后的图片超过配置限制。 |
415 |
APIErrorEnvelope | 使用支持的图片媒体类型。 |
422 |
APIErrorEnvelope | 图片解码后尺寸超过限制。 |
429 |
APIErrorEnvelope | 触发账户级速率或队列限制,遵循 Retry-After 等待。 |
500 |
APIErrorEnvelope | 内部错误,保留任务 ID 和幂等键,仅标记可重试时重试。 |
503 |
APIErrorEnvelope | 服务或供应商不可用,仅 error.retryable 为 true 时重试。 |
响应头
| HTTP | 响应头 | 类型 | 含义 |
|---|---|---|---|
429 |
Retry-After |
integer |
建议等待秒数,遵循服务值并设置总体截止时间。 |
503 |
Retry-After |
integer |
建议等待秒数,遵循服务值并设置总体截止时间。 |
响应示例
{
"byte_size": 1024,
"created_at": "2026-08-30T00:00:00Z",
"height": 512,
"id": "00000000-0000-4000-8000-000000000001",
"mime_type": "image/png",
"object": "file",
"sha256": "0000000000000000000000000000000000000000000000000000000000000000",
"width": 512
}
相关教程
这篇文档有帮助吗?
不收集搜索词、代码或自由文本。此开关只控制文档交互事件;站点通用分析仍遵循隐私政策。 隐私政策