API v1 · AVAILABLE

将视频清理能力
接入你的业务

使用 API Key 创建视频任务、查询处理状态和读取积分余额。

创建 API Key
认证方式Bearer API Key
上传方式multipart/form-data
响应格式JSON
01
AUTHENTICATION

认证

HEADER

在控制台创建 API Key,并通过每次请求的 Authorization Header 发送。完整密钥仅在创建时显示一次。

Authorization Header
Authorization: Bearer wj_live_xxx
保护你的密钥请仅在服务端保存和调用 API Key,不要写入公开的前端代码。
02
TASKS

创建任务

POST
POST/api/v1/tasks

使用 multipart 上传视频。建议每次请求提供唯一的 Idempotency-Key,避免网络重试创建重复任务。

cURL
curl -X POST https://api.example.com/api/v1/tasks
  -H "Authorization: Bearer wj_live_xxx"
  -H "Idempotency-Key: upload-20260815-01"
  -F "product_code=remove_subtitles"
  -F "file=@meeting.mp4"
03
TASK STATUS

查询任务

GET
GET/api/v1/tasks/{task_id}

轮询任务状态直到处理完成。状态会依次进入以下阶段:

queuedprocessingsucceededfailed
JSON Response
{
  "id": "task_xxx",
  "status": "succeeded",
  "settled_points": 1250,
  "output_ready": true
}
04
BALANCE

查询余额

GET
GET/api/v1/balance

查询当前可用积分。余额不足时,创建任务会返回 HTTP 402。

注册并创建第一个 API Key