豆包语音
Key | 说明 | 参数类型 | 是否必须 | Value 示例 |
Key | 说明 | 参数类型 | 是否必须 | Value 示例 |
Content-Type | 固定值 | string | 必须 | "application/json" |
X-Api-Key | string | 必须 | "your-api-key" | |
X-Api-Request-Id | 标识客户端请求ID,uuid随机字符串 | string | 必须 | "67ee89ba-7050-4c04-a3d7-ac61a63499b3" |
Key | 说明 | 参数类型 | 是否必须 | Value 示例 |
Key | 说明 | 参数类型 | 是否必须 | Value 示例 |
Content-Type | 固定值 | string | 必须 | "application/json" |
X-Api-App-Key | string | 必须 | "123456789" | |
X-Api-Access-Key | string | 必须 | "your-access-key" | |
X-Api-Request-Id | 标识客户端请求ID,uuid随机字符串 | string | 必须 | "67ee89ba-7050-4c04-a3d7-ac61a63499b3" |
Key | 说明 | Value 示例 |
Key | 说明 | Value 示例 |
X-Tt-Logid | 服务端返回的 logid,建议用户获取和打印方便定位问题 | 202407261553070FACFE6D19421815D605 |
参数名称 | 层级 | 类型 | 是否必须 | 备注 |
参数名称 | 层级 | 类型 | 是否必须 | 备注 |
speaker_id | 1 | string | 必须 | |
text | 1 | string | 必须 | 试听文本,限制 300 字 |
prompt | 1 | object | 必须 | 提示词,下层级的 text_prompt 和 image_prompt 不能同时为空。同时存在的时候 image_prompt 有更高优先级生效。 |
prompt.text_prompt | 2 | string | 否 | 文本提示词,类似“女性,语速中等偏快,语调低沉有力”,限制 200 字 |
prompt.image_prompt | 2 | object | 否 | 图片提示,下面image_url 和 image_bytes 二选一,大小限制:10M |
prompt.image_prompt.image_url | 3 | string | 否 | 图片提示,这里可以填写可下载的图片 url 地址 |
prompt.image_prompt.image_bytes | 3 | string | 否 | 图片提示,这里可以传图片的 base64 编码之后的结果 (同时存在优先级高) |
language | 1 | int | 否 | 以下为语种对应的枚举值
|
参数名称 | 层级 | 参数类型 | 是否必须 | 备注 |
参数名称 | 层级 | 参数类型 | 是否必须 | 备注 |
code | 1 | int | 可选 | 失败时候HTTP返回非200,该字段返回详细错误码 |
message | 1 | string | 可选 | 失败时候HTTP返回非200,该字段返回详细错误信息 |
available_training_times | 1 | int | 可选 | 剩余可设计次数 |
create_time | 1 | int | 可选 | 创建时间 |
language | 1 | int | 可选 | 以下为语种对应的枚举值
|
speaker_id | 1 | string | 可选 | 唯一音色代号 |
status | 1 | int | 可选 | 请求状态,状态为2或4时都可以调用tts
|
demo_audio | 1 | string | 可选 | Success状态时返回,一小时有效,若需要,请下载后使用 |
参数名称 | 层级 | 参数类型 | 是否必须 | 备注 |
参数名称 | 层级 | 参数类型 | 是否必须 | 备注 |
code | 1 | int | 可选 | 请求失败时候HTTP返回非200,该字段返回详细错误码 |
message | 1 | string | 可选 | 请求失败时候HTTP返回非200,该字段返回详细错误信息 |
错误码分类 | 错误码表示 |
错误码分类 | 错误码表示 |
服务端报错 | 8位错误码,以5开头,例如:50001201 |
客户操作错误导致的服务端报错 | 8位错误码,以4开头,例如:40001101 |
错误码code | 状态信息message | 原因 | 解决方案 |
错误码code | 状态信息message | 原因 | 解决方案 |
45001001 | 请求参数有误 | 参数缺失/格式不对/不符合约束 | 按接口校验规则修正参数;补齐必填字段;检查枚举值 |
45001123 | 达到设计次数上限 | 超过音色设计次数限制 | 更换为还有设计次数的 speaker_id |
55001308 | 音色设计失败 | 下游失败/超时/返回异常 | 服务异常、可能需要重试 |
接口 | 推荐场景 | 接口功能 | 文档链接 |
接口 | 推荐场景 | 接口功能 | 文档链接 |
wss://openspeech.bytedance.com/api/v3/tts/bidirection | WebSocket协议,实时交互场景,支持文本实时流式输入,流式输出音频。 | 语音合成、声音复刻、混音 | |
wss://openspeech.bytedance.com/api/v3/tts/unidirectional/stream | WebSocket协议,一次性输入合成文本,流式输出音频。 | 语音合成、声音复刻、混音 | |
https://openspeech.bytedance.com/api/v3/tts/unidirectional | HTTP Chunked协议,一次性输入全部合成文本,流式输出音频。 | 语音合成、声音复刻、混音 | |
https://openspeech.bytedance.com/api/v3/tts/unidirectional/sse | HTTP SSE协议,一次性输入全部合成文本,流式输出音频。 | 语音合成、声音复刻、混音 |