API 文档中心

视频文本擦除任务状态接口


更新时间:2026-05-11

视频文本擦除

服务概述

  • 查询视频文本擦除任务状态,支持单任务与批量任务轮询。

服务申请

视频文本擦除 API 采用控制台项目接入模式。用户可前往ViiTor AI官网 (https://www.viitor.com/) 注册并开通服务,在控制台创建项目后可获得鉴权所需信息。

业务服务地址由项目网关提供;本文档示例基于当前业务网关:

https://video-translation.ilivedata.com


接入方式

参数规范

  • 请求 URL:https://video-translation.ilivedata.com/textRemoval/taskStatus
  • 请求方法:POST
  • Content-Type:application/json
  • 返回结构:{code, message, data}

HTTP请求头

Header必填类型说明
Content-TypeStringapplication/json;charset=UTF-8
AcceptStringapplication/json;charset=UTF-8
X-User-IdLong用户ID,必须为数字
Authorization建议String登录态令牌(Bearer Token),按网关鉴权策略传递
X-ChannelInteger渠道编码;本接口不参与业务处理
X-App-SourceString来源标识;本接口不参与业务处理

说明:

  • 本接口仅从 Header 读取 X-User-Id 作为查询用户。
  • 若缺失 X-User-Id,返回 code=2000;若非数字,返回 code=2001

请求方法:POST

请求体

字段定义

字段类型必填说明
taskIdString单个任务ID
taskIdsArray批量任务ID列表

参数规则

  1. taskIdtaskIds 不能同时为空。
  2. 两者会被服务端合并并去重后查询。
  3. 合并后的任务ID数量最多 100 个。
  4. 每个任务ID都必须以 ViiTor_AI 开头,否则返回参数错误。

响应体

统一返回结构

字段类型说明
codeInteger0 表示成功,非 0 表示失败
messageString返回信息
dataArray<Object>任务状态列表

成功时 data 元素字段

字段类型说明
taskIdString任务ID
taskStatusInteger任务状态码
taskProgressInteger任务进度(0-100)
errorCodeInteger任务错误码(成功通常为 0
targetVideoUrlString结果视频URL(任务完成后返回)
updateTimeLong最近更新时间(毫秒时间戳)

taskStatus 状态码说明

数值含义
1已创建
2队列中
3运行中
4已结束
5失败
6已中止

调用示例

请求示例(cURL,单任务)

curl -X POST "https://video-translation.ilivedata.com/textRemoval/taskStatus" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "X-User-Id: 123456" \
  -d '{
    "taskId": "ViiTor_AI_202605110001"
  }'

请求示例(cURL,批量)

curl -X POST "https://video-translation.ilivedata.com/textRemoval/taskStatus" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "X-User-Id: 123456" \
  -d '{
    "taskIds": [
      "ViiTor_AI_202605110001",
      "ViiTor_AI_202605110002"
    ]
  }'

成功响应示例

{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "taskId": "ViiTor_AI_202605110001",
      "taskStatus": 3,
      "taskProgress": 60,
      "errorCode": 0,
      "targetVideoUrl": null,
      "updateTime": 1776057600123
    },
    {
      "taskId": "ViiTor_AI_202605110002",
      "taskStatus": 4,
      "taskProgress": 100,
      "errorCode": 0,
      "targetVideoUrl": "https://cdn.example.com/output/video_110002.mp4",
      "updateTime": 1776057650456
    }
  ]
}

失败响应示例(参数错误)

{
  "code": 2001,
  "message": "taskId and taskIds cannot both be empty",
  "data": null
}

常见错误码

错误码含义典型原因
2000Missing Parameter缺少 X-User-Id
2001Invalid Parameter参数不合法(taskId/taskIds 为空、格式错误、数量超限)

客户端接入建议

  1. 创建任务后保存 taskId,建议使用批量模式轮询。
  2. taskStatus=4targetVideoUrl 非空时可下载结果。
  3. taskStatus=5/6 时结合 errorCode 做失败提示与重试策略。

© 2026 由 ViiTor AI 设计和开发