You need to enable JavaScript to run this app.
文档中心
机器翻译

机器翻译

复制全文
下载 pdf
任务管理
VideoProjectCreateToolTask - 创建工具任务
复制全文
下载 pdf
VideoProjectCreateToolTask - 创建工具任务

创建工具任务(字幕擦除/背景音处理/字幕提取/视频压制/字幕文件翻译)

使用说明

Post请求

注意事项

必须要工具项目下使用

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

VideoProjectCreateToolTask

要执行的操作,取值:VideoProjectCreateToolTask。

Version
String
是

2021-05-21

API的版本,取值:2021-05-21。

videoIDs
Array of String
否

["v1234zz", "v6789aa"]

要处理的视频的vid

projectId
String
是

12345

工具项目 id,创建工具任务的所属项目id,必须是工具项目

taskType
Integer
否

1

工具任务类型:
任务类型:

  • 1: 字幕擦除
  • 2: 背景音处理
  • 3: 字幕提取
  • 4: 字幕文件翻译
  • 5: 视频压制
toolParamsJson
String
否

{"AiRemoveType":1,"VideoInfos":[{"VideoID":"v0123","EpisodeNum":1},{"VideoID":"v0123","EpisodeNum":2}]}

任务参数序列化后的json字符串

必传:VideoInfos: 视频信息,工具任务都需要传(字幕文件翻译任务除外),包含
		- VideoID:String, 视频vid
		- EpisodeNum:Integer, 集数 
		- TargetCaptionURL:String, 字幕文件地址(仅视频压制任务传)

字幕擦除任务:
	可传:AiRemoveType 如果不传默认用2; 1是普通擦除,2是精细化擦除;
	
背景音处理任务:
	可传:BgmPolicy: 如果不传默认用3;
	    1 = NoMusic(消除音乐)
	    2 = NoAmbient(消除环境音)
			3 = 两者都消除

字幕提取任务:
	必须传:Language: 语种代码,如:zh
	可传:RecognitionMethod: 1=OCR,2=ASR,默认 1
	可传:ExtractType: 1=基础版,2=标准版,3=高级版,默认 1  
	输出内容的区别:
		- 基础版:时间轴+字幕;(基础版必须传 RecognitionMethod)
		- 标准版:时间轴+说话人序号+字幕
		- 高级版:时间轴+角色名+字幕


视频压制任务:
	必须传:VideoInfos[].TargetCaptionURL: String; 字幕文件地址;
	必须传:TargetStyle: 字幕样式对象,包含以下字段:
    font_size: Integer,如:42,
    font_color: String,如:"#FFFFFF",
    stroke_color: String,如:"#000000",
    stroke_width: Integer,如:2,
    position: String,如:"bottom"

字幕文件翻译任务:
	不需要传:VideoInfos
	必须传:SourceLanguage: String, 上传的字幕文件语言,如:en
	必须传:TargetLanguage: String, 上传的字幕文件语言,如:zh
	必须传:UploadSubtitleInfos: Array of Object;字幕文件对象包含以下字段:
		FileType: Integer,文件类型,1是srt格式,2是ass格式,如:1
		Langs: Array of String,上传的字幕文件语言,如:['en']
		Name: String, 字幕文件名称,如:"ep1.srt"
		ProjectID: Integer, 项目id,如:123456789
		URL: String,字幕文件地址,如:"https://example.com/subtitles/ep1.srt"

	可传:TermFile: 术语文件对象,包含以下字段:
		FileName: String, 术语文件名称,如:"glossary.xlsx",模板文件见表格下方
		FileType: String, 术语文件类型,目前仅支持"xlsx"
		FileURL: String, 术语文件URL,如:"https://example.com/term/glossary.xlsx"

术语模板文件:

术语模板文件.xlsx
7.44KB

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
data
Object

123

创建工具任务返回值

请求示例

POST /?Action=VideoProjectCreateToolTask&Version=2021-05-21 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260527T070617Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260527/cn-beijing/i18n_openapi/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "projectId": "12345",
  "videoIDs": ["v123", "v456"],
  "taskType": 1,
  "toolParamsJson": "{\"AiRemoveType\":1,\"VideoID\":\"v01234\"}"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20260527150646161065162220AE070F",
    "Action": "VideoProjectCreateToolTask",
    "Version": "2021-05-21",
    "Service": "i18n_openapi",
    "Region": "cn-beijing"
  },
  "Result": {
    "data": {
    	"taskId": "12341234"
    }
  }
}

错误码

您可访问公共错误码,获取更多错误码信息。

最近更新时间:2026.08.20 20:04:36
这个页面对您有帮助吗?
有用
有用
无用
无用