跳转到主要内容
POST
创建翻译配音任务

授权

Authorization
string
header
必填

Authorization 请求头中传入 API Key(Bearer <api_key>)。见 鉴权

请求头

X-Idempotency-Key
string
必填

创建任务或修改持久化数据的 POST 必填(最长 64 字符)。见 幂等

Maximum string length: 64

请求体

application/json
taskType
enum<string>
必填

vt = 视频翻译,at = 音频翻译。若 at 对应视频素材,任务可能按视频翻译执行

可用选项:
vt,
at
source
object
必填

本任务的输入素材

language
object
必填

本地化源语言与目标语言

options
object
必填

流水线选项:配音、ASR、翻译、分离、唇形同步与字幕

extraData
object

可选客户端元数据;完成时在 Webhook 中回传

回调

POST
https://{yourWebhookUrl}taskCompleted

请求体

application/json

eventopenapi-media-translation 时的媒体翻译 Webhook 请求体data.result 为 CDN 交付物。

data
object
必填

Webhook 中 eventopenapi-media-translation 时,data 内的任务载荷(data.result 含 CDN 交付物)。

code
integer

本次投递的业务结果码

示例:

200

version
string

任务的 API 版本号(如 v1v2),与请求路径中的版本一致(如 /openapi/v1/...)。

示例:

"v1"

event
enum<string>

已完成的产品类型。请按此值路由:openapi-tts(TTS)、openapi-translate(文本翻译)、openapi-clone-voice(声音克隆)、openapi-media-translation(音视频翻译)。详见 Webhook 请求体

可用选项:
openapi-tts,
openapi-translate,
openapi-clone-voice,
openapi-media-translation
示例:

"openapi-tts"

pipelineKey
string

该次异步完成的稳定标识。请用此字段对接收端去重 — 见 Webhook 请求体

示例:

"a1b2c3d4e5f6789012345678901234ab"

message
string

code 非成功时的说明

extraData
object

与异步提交请求中的 extraData 一致

响应

200

请尽快返回 2xx 以停止重试

响应

200 - application/json

仅返回受理信息(taskIdtaskTypestatuscreatedAt)。最终生成结果在 Webhook 回调请求体中。

code
integer
必填

业务码;200 表示成功

示例:

200

message
string

code 非成功时的说明信息

示例:

""

data
object

音视频翻译异步创建的立即响应(不含交付物)