跳到导航

电商视频

POST https://api.beatapi.io/v1/ecommerce-video/tasks

使用商品图片和明确的输出时长创建电商视频工作流任务。

鉴权

Authorization   string   必填

在 Authorization 请求头中以 Bearer 令牌发送服务端 API 密钥,可在控制台创建。

Authorization: Bearer <BEATAPI_API_KEY>

永久 API 密钥只能保存在可信服务端,不能写入浏览器、移动端、公开脚本、日志或截图。请求体必须使用 Content-Type: application/json。建议为每个逻辑创建请求设置唯一的 Idempotency-Key,只有完全相同的请求体才能安全复用原键。

请求体

字段名、类型和枚举值保留英文原样,用途和限制用中文说明。

本地素材无法通过公网 HTTPS URL 访问时,请先上传输入文件,再使用返回的 data.url。

images   string[]   必填

按当前模型或工作流要求排序的公网 HTTPS 图片 URL 列表。

取值与默认值: 1–7 项


duration   integer   必填

请求的输出时长,单位为秒。

取值与默认值: 取值范围 10–60


prompt   string   选填

描述生成、编辑或分析目标的提示词。

取值与默认值: 最多 2000 字符


aspect_ratio   enum<string>   选填

输出素材的宽高比。

取值与默认值: 可选值 16:9、9:16、1:1


language   enum<string>   选填

对话、旁白或歌词使用的语言。中英文混合时建议显式指定。

取值与默认值: 可选值 en、zh

响应

成功请求返回 HTTP 201,响应体如下。

{
"data": {
"id": "task_p9Lm2",
"object": "task",
"task_kind": "workflow",
"capability_id": "ecommerce-video",
"capability_version": 1,
"workflow": "ecommerce-video",
"status": "queued",
"stage": "queued",
"created_at": 1782210000,
"updated_at": 1782210000,
"completed_at": null,
"output": null,
"usage": {
"credits_reserved": 4.5,
"credits_charged": 4.5,
"billable_duration_seconds": 15,
"credits_settled": 0,
"credits_refunded": 0
},
"request_id": "req_def456",
"error_code": null,
"error_message": null
}
}

下一步

保存接受响应中的 data.id,每 5–10 秒轮询 GET /v1/tasks/{task_id}。任务成功后从 data.output.media 读取托管结果。

错误

状态码含义与处理方式
400JSON 格式错误,或字段、取值、参数组合不被接受(bad_request,错误信息会点名字段);输入未通过内容审核时为 content_policy_violation。修正后再请求,原样重试仍会失败。
401未提供 API 密钥(missing_api_key),或密钥错误、已过期、已停用或额度已用尽(invalid_api_key,错误信息会说明是哪一种)。不要原样重试。
402余额不足(insufficient_credits):账户余额为零或低于本次请求的价格。充值后再请求。
403密钥或账户无权执行该调用(forbidden),例如免费额度不能使用该模型(充值即可解锁)、请求来源不在密钥的 IP 白名单内,或模型不在密钥的分组里。不要原样重试。
409幂等键在 24 小时内已用于其他请求体或路径,或使用该键的首个请求仍在处理中(idempotency_conflict)。只对完全相同的请求复用原键。
429请求过于频繁(rate_limit_exceeded,含免费模型限额)。按 Retry-After(也在 error.retry_after_seconds)等待后重试。
500内部异常(internal_error),可以重试;持续出现时请保留 request_id 联系支持。
503请求未能完成(processing_unavailable、processing_timeout、processing_failed 或 result_transfer_failed),未扣费,可退避重试;503 不带 Retry-After 和 retry_after_seconds。BeatAPI 不返回 502 或 504。实时接口在本部署未启用时为 realtime_disabled(不可重试),容量暂时不足时为 realtime_capacity_unavailable(可重试)。