跳转到主要内容
POST
合成语音(异步)

授权

Authorization
string
header
必填

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

请求头

X-Idempotency-Key
string
必填

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

Maximum string length: 64

请求体

application/json
data
object[]
必填

待合成文本(最多 50 条)。每条需 text音色 中的 voiceIdtimbreRefAudio

Maximum array length: 50
provider
string
已弃用

已弃用 — 请勿传入。请在每行传入 voiceId。见 文本转语音支持的克隆方式

language
object

合成目标语言

trim
boolean
默认值:false

true 时裁剪输出音频首尾静音

outputFormat
enum<string>
默认值:m4a

输出音频格式:wavmp3m4a

可用选项:
wav,
mp3,
m4a
extraData
object

异步提交时的可选客户端元数据;任务完成时在 Webhook 回调体 extraData 中回显。同步创建接口不使用。

回调

POST
https://{yourWebhookUrl}taskCompleted

请求体

application/json

eventopenapi-tts 时的 TTS Webhook 请求体dataresultstaskId。见 Webhook 请求体创建 TTS(异步)Callbacks

data
object
必填

eventopenapi-tts 时的产品结果;dataresultstaskId

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

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

code
integer
必填

业务码;200 表示成功

示例:

200

message
string

code 非成功时的说明信息

示例:

""

data
object

异步提交后的立即响应(不含任务结果)