API 文档中心

图片/视频擦除接口

更新时间:2026-07-14

服务概述

  • 创建视频或图片文本擦除任务。
  • 支持分页查询任务、批量查询任务状态。
  • 任务为异步处理模式:创建任务后返回 taskId,客户端轮询 taskStatus 获取进度和结果 URL。

服务地址

https://video-translation.viitor.com


鉴权方式

Authorization: Bearer vt_live_xxx

公共响应结构

字段类型说明
codeInteger0 表示成功,非 0 表示失败
messageString返回信息
dataObject / Array / Boolean业务数据

任务状态枚举

说明
1已创建
2队列中
3运行中
4已结束
5失败
6已中止

mediaType 枚举

说明
1视频
2图片

1. 创建擦除任务

接入方式

  • 请求 URL:https://video-translation.viitor.com/openapi/v1/video-text-removal/add
  • 请求方法:POST
  • Content-Type:application/json

HTTP 请求头

Header必填类型说明
Content-TypeStringapplication/json;charset=UTF-8
Accept建议Stringapplication/json;charset=UTF-8
AuthorizationStringBearer <API_KEY>

请求体字段

字段类型必填说明
urlString源视频或源图片 URL
taskNameString任务名称,超过 50 字符会截断
mediaTypeInteger媒体类型:1 视频,2 图片;默认 1
textDetectROIArray文本检测区域,自动擦除区域内识别到的文本
fullEraseROIArray整块擦除区域,用于擦除字幕、文字和水印

区域格式说明

textDetectROIfullEraseROI 二者至少传入一个,二者均为二维数组,每个子数组表示一个矩形区域。坐标含义以业务处理服务约定为准,通常可按 [x1, y1, x2, y2] 传递。

成功时 data 字段

字段类型说明
userIdLongAPI Key 绑定的用户 ID
taskIdString任务 ID
mediaTypeInteger媒体类型

请求示例

curl -X POST "https://video-translation.viitor.com/openapi/v1/video-text-removal/add" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer vt_live_xxx" \
  -d '{
    "url": "https://cdn.example.com/video/source.mp4",
    "taskName": "Text removal task 001",
    "mediaType": 1,
    "textDetectROI": [[100, 200, 800, 320]]
  }'

成功响应示例

{
  "code": 0,
  "message": "OK",
  "data": {
    "userId": 123456,
    "taskId": "ViiTor_AI_50C7A13A74DC46D8B31EAEF3382895BA",
    "mediaType": 1
  }
}

2. 分页查询任务

  • 请求 URL:https://video-translation.viitor.com/openapi/v1/video-text-removal/pageList
  • 请求方法:POST
  • 请求头:同创建擦除任务接口
字段类型必填说明
currentInteger当前页,默认按服务端规则处理
pageSizeInteger每页数量,默认按服务端规则处理
taskNameString任务名称筛选,最长 100 字符
mediaTypeInteger媒体类型:1 视频,2 图片

成功时记录字段:

字段类型说明
taskIdString任务 ID
mediaTypeInteger媒体类型
durationLong媒体时长
targetVideoUrlString结果视频 URL
targetImageUrlString结果图片 URL
taskStatusInteger任务状态
errorCodeInteger错误码
taskNameString任务名称
taskProgressInteger任务进度
createTimeLong创建时间

请求示例

curl -X POST "https://video-translation.viitor.com/openapi/v1/video-text-removal/pageList" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer vt_live_xxx" \
  -d '{
    "current": 1,
    "pageSize": 10,
    "mediaType": 1
  }'

成功响应示例

{
  "code": 0,
  "message": "OK",
  "data": {
    "current": 1,
    "size": 10,
    "total": 1,
    "pages": 1,
    "records": [
      {
        "taskId": "ViiTor_AI_50C7A13A74DC46D8B31EAEF3382895BA",
        "mediaType": 1,
        "duration": 30000,
        "targetVideoUrl": "https://cdn.example.com/video/result.mp4",
        "taskStatus": 4,
        "errorCode": 0,
        "taskName": "Text removal task 001",
        "taskProgress": 100,
        "createTime": 1720000000000
      }
    ]
  }
}

3. 查询任务状态

  • 请求 URL:https://video-translation.viitor.com/openapi/v1/video-text-removal/taskStatus
  • 请求方法:POST
  • 请求头:同创建擦除任务接口
字段类型必填说明
taskIdString条件必填单个任务 ID;taskIdtaskIds 至少传一个
taskIdsArray条件必填批量任务 ID,最多 100 个

成功时 data 为数组:

字段类型说明
taskIdString任务 ID
mediaTypeInteger媒体类型
taskStatusInteger任务状态
taskProgressInteger任务进度
errorCodeInteger错误码
targetVideoUrlString结果视频 URL
targetImageUrlString结果图片 URL
updateTimeLong更新时间

请求示例

curl -X POST "https://video-translation.viitor.com/openapi/v1/video-text-removal/taskStatus" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer vt_live_xxx" \
  -d '{
    "taskIds": [
      "ViiTor_AI_50C7A13A74DC46D8B31EAEF3382895BA"
    ]
  }'

成功响应示例

{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "taskId": "ViiTor_AI_50C7A13A74DC46D8B31EAEF3382895BA",
      "mediaType": 1,
      "taskStatus": 4,
      "taskProgress": 100,
      "errorCode": 0,
      "targetVideoUrl": "https://cdn.example.com/video/result.mp4",
      "updateTime": 1720000300000
    }
  ]
}

常见错误码

codemessage说明
0OK成功
1103No Privilege账号不是 VIP 或无权限调用
2001Invalid Parameter参数非法
400001missing_api_key缺少 API Key
400002invalid_api_keyAPI Key 无效
400003disabled_api_keyAPI Key 已禁用
400004expired_api_keyAPI Key 已过期

© 2026 由 ViiTor AI 设计和开发