公共协议-HTTP--音频技术-火山引擎

文档中心

导航

公共协议-HTTP

最近更新时间：2023.09.07 15:02:46首次发布时间：2021.08.23 16:15:12

目前支持HTTP API提供非流式的调用，请求地址：https://sami.bytedance.com

备注：HTTP API统一默认超时时间为1分钟（如具体API文档有特殊说明，则以对应说明为准），可能因为用户请求数据过大或者网络波动等问题，耗时过大出现504超时错误。

HTTP请求体Content-Type: application/json

字段	描述	类型	是否必传	默认值
token	服务鉴权token，获取方式见服务鉴权-获取token	string	是	-
appkey	服务接入appkey。在音频技术控制台创建应用后获得	string	是	-
namespace	服务接口命名空间，比如`TTS`	string	是	-
data	服务请求二进制数据，比如音频二进制数据，标准base64编码。	string	否	-
payload	服务请求配置参数，比如音频编码信息等。具体填写要求详见对应API接口说明文档	string	否	-
payload.url	服务请求数据的url，需要公网公开可访问，比如音频二进制数据音频示例。若data字段不空，则以`data`为准；若data字段为空，则使用`payload.url`下载音频数据	string	否	-

HTTP响应体Content-Type: application/json

字段	描述	类型
task_id	请求任务id，用于链路追踪、问题排查	string
namespace	服务接口命名空间，比如`TTS`	string
data	请求响应二进制数据，标准base64编码	string
payload	请求响应文本信息，json字符串格式。详见具体API接口说明文档	string
status_code	状态码。详见服务状态码	number
status_text	状态信息。详见服务状态码	string

HTTP响应头

字段	描述	类型
X-Tt-Logid	请求链路id，用于链路追踪、问题排查；当由于网络等原因没有收到预期内的HTTP响应体时（找不到`task_id`的情况），可以提供该参数用于问题排查	string

常见问题