错误
VIDIO API 使用一致的错误对象格式。使用此页面来理解常见的错误类型、HTTP 状态码和 API 返回的示例信息。
API 访问目前仅适用于 Studio 计划及以上。
概述
当请求失败时,VIDIO API 会返回一个 error 对象,包含 type 和 message。某些错误可能还包括附加字段,以帮助解释失败的原因。
错误格式
json
{
"error": {
"type": "invalid_request_error",
"message": "未找到作业"
}
}错误参考
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | 上传 URL 请求中缺少必需的查询参数 | 当上传 URL 请求中缺少必需的查询参数时返回。 |
| 400 | invalid_request_error | 缺少 job_id | 当渲染请求不包含 job_id 时返回。 |
| 400 | invalid_request_error | 该作业没有可用的输出 | 当作业没有任何可渲染的输出时返回。 |
| 400 | invalid_request_error | input_keys 必须是非空数组 | 当 `input_keys` 缺失或为空时返回。 |
| 400 | invalid_request_error | input_keys 必须包含至少一个有效的输入键 | 当提供的所有输入键在标准化后为空或无效时返回。 |
| 400 | input_duration_requirement_error | 总输入时长必须大于2秒 | 当所有输入媒体的总时长小于或等于2秒时返回。 |
| 400 | input_duration_requirement_error | 总输入时长必须少于6小时 | 当所有输入媒体的总时长大于或等于6小时时返回。 |
| 400 | input_image_count_requirement_error | 输入图片数量不得超过4000 | 当输入图片数量超过允许的最大限制4000时返回。 |
| 400 | input_video_count_requirement_error | 输入视频数量不得超过400 | 当输入视频数量超过允许的最大限制400时返回。 |
| 400 | invalid_request_error | 无效的 video_category。允许的值:podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others | 当 `video_category` 不受支持时返回。 |
| 400 | invalid_request_error | 无效的 aspect_ratio。允许的值:square, portrait, landscape | 当 `aspect_ratio` 不受支持时返回。 |
| 400 | invalid_request_error | output_length 必须为正数 | 当 `output_length` 缺失、为零或为负时返回。 |
| 400 | invalid_request_error | 无法从 `input_keys` 元数据中确定大于零的输入时长 | 当 API 无法确定上传输入的有效时长时返回。 |
| 401 | authentication_error | 缺少 API 密钥 | 当未提供 `x-api-key` 头时返回。 |
| 401 | authentication_error | 无效的 API 密钥 | 当提供的 API 密钥与有效密钥不匹配时返回。 |
| 402 | insufficient_balance | 您的余额不足以处理此作业 | 当账户没有足够的积分用于处理或渲染时返回。 |
| 403 | permission_error | 您无权访问此作业 | 当经过身份验证的用户不拥有请求的作业时返回。 |
| 403 | permission_error | 您无权渲染此作业 | 当经过身份验证的用户不拥有正在渲染的作业时返回。 |
| 404 | invalid_request_error | 未找到作业 | 当请求的作业不存在时返回。 |
| 404 | invalid_request_error | 未找到用户 | 当无法找到经过身份验证的用户记录时返回。 |
| 429 | rate_limit_error | 请求过多 | 当客户端超过该端点允许的请求速率时返回。当前限制是每分钟60次请求。速率限制主要基于使用 x-api-key 头的 API 密钥;当未提供 API 密钥时,则回退到客户端 IP 地址。达到此限制的客户端应减少请求频率,并在速率限制窗口重置后重试。 |
| 500 | api_error | 身份验证错误 | 当服务器上 API 密钥身份验证意外失败时返回。 |
| 500 | api_error | 内部服务器错误 | 当状态、渲染或精彩集端点发生意外的服务器端故障时返回。 |
| 500 | server_error | 生成上传 URL 失败 | 当服务器无法生成签名的上传 URL 时返回。 |