图片/视频擦除接口
更新时间:2026-07-14
- 创建视频或图片文本擦除任务。
- 支持分页查询任务、批量查询任务状态。
- 任务为异步处理模式:创建任务后返回
taskId,客户端轮询 taskStatus 获取进度和结果 URL。
https://video-translation.viitor.com
Authorization: Bearer vt_live_xxx
| 字段 | 类型 | 说明 |
|---|
code | Integer | 0 表示成功,非 0 表示失败 |
message | String | 返回信息 |
data | Object / Array / Boolean | 业务数据 |
| 值 | 说明 |
|---|
1 | 已创建 |
2 | 队列中 |
3 | 运行中 |
4 | 已结束 |
5 | 失败 |
6 | 已中止 |
- 请求 URL:
https://video-translation.viitor.com/openapi/v1/video-text-removal/add - 请求方法:
POST - Content-Type:
application/json
| Header | 必填 | 类型 | 说明 |
|---|
Content-Type | 是 | String | application/json;charset=UTF-8 |
Accept | 建议 | String | application/json;charset=UTF-8 |
Authorization | 是 | String | Bearer <API_KEY> |
| 字段 | 类型 | 必填 | 说明 |
|---|
url | String | 是 | 源视频或源图片 URL |
taskName | String | 是 | 任务名称,超过 50 字符会截断 |
mediaType | Integer | 否 | 媒体类型:1 视频,2 图片;默认 1 |
textDetectROI | Array | 否 | 文本检测区域,自动擦除区域内识别到的文本 |
fullEraseROI | Array | 否 | 整块擦除区域,用于擦除字幕、文字和水印 |
textDetectROI、fullEraseROI 二者至少传入一个,二者均为二维数组,每个子数组表示一个矩形区域。坐标含义以业务处理服务约定为准,通常可按 [x1, y1, x2, y2] 传递。
| 字段 | 类型 | 说明 |
|---|
userId | Long | API Key 绑定的用户 ID |
taskId | String | 任务 ID |
mediaType | Integer | 媒体类型 |
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
}
}
- 请求 URL:
https://video-translation.viitor.com/openapi/v1/video-text-removal/pageList - 请求方法:
POST - 请求头:同创建擦除任务接口
| 字段 | 类型 | 必填 | 说明 |
|---|
current | Integer | 否 | 当前页,默认按服务端规则处理 |
pageSize | Integer | 否 | 每页数量,默认按服务端规则处理 |
taskName | String | 否 | 任务名称筛选,最长 100 字符 |
mediaType | Integer | 否 | 媒体类型:1 视频,2 图片 |
成功时记录字段:
| 字段 | 类型 | 说明 |
|---|
taskId | String | 任务 ID |
mediaType | Integer | 媒体类型 |
duration | Long | 媒体时长 |
targetVideoUrl | String | 结果视频 URL |
targetImageUrl | String | 结果图片 URL |
taskStatus | Integer | 任务状态 |
errorCode | Integer | 错误码 |
taskName | String | 任务名称 |
taskProgress | Integer | 任务进度 |
createTime | Long | 创建时间 |
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
}
]
}
}
- 请求 URL:
https://video-translation.viitor.com/openapi/v1/video-text-removal/taskStatus - 请求方法:
POST - 请求头:同创建擦除任务接口
| 字段 | 类型 | 必填 | 说明 |
|---|
taskId | String | 条件必填 | 单个任务 ID;taskId 和 taskIds 至少传一个 |
taskIds | Array | 条件必填 | 批量任务 ID,最多 100 个 |
成功时 data 为数组:
| 字段 | 类型 | 说明 |
|---|
taskId | String | 任务 ID |
mediaType | Integer | 媒体类型 |
taskStatus | Integer | 任务状态 |
taskProgress | Integer | 任务进度 |
errorCode | Integer | 错误码 |
targetVideoUrl | String | 结果视频 URL |
targetImageUrl | String | 结果图片 URL |
updateTime | Long | 更新时间 |
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
}
]
}
| code | message | 说明 |
|---|
0 | OK | 成功 |
1103 | No Privilege | 账号不是 VIP 或无权限调用 |
2001 | Invalid Parameter | 参数非法 |
400001 | missing_api_key | 缺少 API Key |
400002 | invalid_api_key | API Key 无效 |
400003 | disabled_api_key | API Key 已禁用 |
400004 | expired_api_key | API Key 已过期 |