电商视频

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:99:161:1


language   enum<string>   选填

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

取值与默认值: 可选值 enzh

响应

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

1{
2 "data": {
3 "id": "task_p9Lm2",
4 "object": "task",
5 "task_kind": "workflow",
6 "capability_id": "ecommerce-video",
7 "capability_version": 1,
8 "workflow": "ecommerce-video",
9 "status": "queued",
10 "stage": "queued",
11 "created_at": 1782210000,
12 "updated_at": 1782210000,
13 "completed_at": null,
14 "output": null,
15 "usage": {
16 "credits_reserved": 4.5,
17 "credits_charged": 4.5,
18 "billable_duration_seconds": 15,
19 "credits_settled": 0,
20 "credits_refunded": 0
21 },
22 "request_id": "req_def456",
23 "error_code": null,
24 "error_message": null
25 }
26}

下一步

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

错误

状态码含义与处理方式
400请求字段、格式、取值或参数组合不合法,请修正后重新请求。
401API 密钥缺失、无效或未启用。
402USD 余额不足,请充值后再创建付费任务。
409幂等键已对应其他请求体,仅能对完全相同的逻辑请求复用原键。
429超过请求频率或并发上限,请遵守 Retry-After 或返回的等待时间。