错误
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 | 当渲染请求未包含作业 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 无法确定上传输入的有效时长时返回。 |
| 400 | invalid_request_error | music_volume 必须是介于 0 到 100 之间的数字 | 当提供了 `music_volume` 但其不是介于 0 到 100 的有效数字时返回。 |
| 400 | invalid_request_error | original_audio_volume 必须是介于 0 到 100 之间的数字 | 当提供了 `original_audio_volume` 但其不是介于 0 到 100 的有效数字时返回。 |
| 400 | invalid_request_error | 无效的 music_category。允许的值:corporate、romantic、sports、kids_and_comedy、ambient_and_nature、horror_and_suspense、documentary、trending_vlogs | 当提供的 `music_category` 不匹配任何受支持的音乐类别时返回。 |
| 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 地址。达到此限制的客户端应降低请求频率,并在速率限制窗口重置后重试。 |
| 429 | rate_limit_error | 您已拥有 10 个正在运行或排队的作业,这是允许的最大数量。请在提交另一个作业之前等待一些作业完成。 | 当用户在服务器上正在运行的作业和队列中待处理的作业总数已达到允许的最大值时返回。当前限制是每个用户最多 10 个运行中或排队的作业。所有权通过将繁忙服务器和待处理队列条目中的每个 job_id 与作业的 user_email 匹配来确定。达到此限制的客户端应等待一个或多个现有作业完成,然后再创建或渲染另一个作业。 |
| 500 | api_error | 认证错误 | 当服务器上 API 密钥认证意外失败时返回。 |
| 500 | api_error | 内部服务器错误 | 当 status、render 或 highlight reel 端点发生意外的服务器端故障时返回。 |
| 500 | server_error | 生成上传 URL 失败 | 当服务器无法生成签名的上传 URL 时返回。 |