开放 API 文档

鉴权:请求头携带 X-API-Key: <你的Key>(门户「API 接入」页获取/轮换)。 所有写操作经配额与预算护栏;幂等:同任务重试自动去重。

POST/v1/tenants/{tid}/tasks

建单(宣传片/仿写/参数短片/数字人口播),配额与预算护栏自动生效

{
  "type": "promo",            // promo | imitate | param | avatar
  "tier": "basic",            // basic | enterprise(跟随租户套餐)
  "style": "params",          // persona | params | tutorial | compare | avatar
  "brief": "数控机床 15 秒宣传片,突出精度 ±0.003mm",
  "duration_sec": 15,         // 10-60
  "aspect": "9:16",           // 9:16 | 16:9 | 1:1
  "voice_id": "sandbox_male_steady",  // 数字人口播音色(可选)
  "subtitles": true,          // 烧录字幕(可选)
  "distribute": [             // 成片后自动分发(可选)
    { "channel": "douyin", "accountId": "dy_xxx" }
  ]
}
// 响应
{ "taskId": "b1fe25ad-…", "status": "queued" }
GET/v1/tenants/{tid}/tasks

任务列表(含进度/分镜/成片临时直链;output_url 为即时签发的 24h 链接)

// 响应
[{ "id": "…", "status": "done", "progress": 100, "output_url": "https://…" }]
PATCH/v1/tenants/{tid}/tasks/{id}

取消(status=cancelled)或重试(retry=true,自动重置后重跑)

{ "retry": true }
// 响应
{ "id": "…", "retried": true }
POST/v1/tenants/{tid}/tasks/{id}/distribute

成片分发(channels/douyin/miniprogram;海外渠道 TikTok/YouTube 见渠道矩阵)

{ "channel": "douyin", "accountId": "dy_main", "mount": {} }
// 响应
{ "distributionId": "…", "status": "pending" }
错误码
401凭证无效(API Key 不存在或已轮换)
402配额/预算不足(QUOTA_EXCEEDED / FREE_QUOTA_EXCEEDED / BUDGET_EXCEEDED)
403凭证与租户不匹配(无权操作该 tid)
404任务/租户不存在
409任务未完成即请求分发,或成片待人工复核(敏感词改写)
429触发速率限制(100 次/分钟/IP)

← 返回官网