跳转到主要内容
POST
/
text-to-audio
文字转语音
curl --request POST \
  --url https://{api_base_url}/text-to-audio \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Hello, welcome to our service.",
  "user": "abc-123",
  "voice": "alloy",
  "streaming": false
}
'
import requests

url = "https://{api_base_url}/text-to-audio"

payload = {
"text": "Hello, welcome to our service.",
"user": "abc-123",
"voice": "alloy",
"streaming": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: 'Hello, welcome to our service.',
user: 'abc-123',
voice: 'alloy',
streaming: false
})
};

fetch('https://{api_base_url}/text-to-audio', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/text-to-audio",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'text' => 'Hello, welcome to our service.',
'user' => 'abc-123',
'voice' => 'alloy',
'streaming' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://{api_base_url}/text-to-audio"

payload := strings.NewReader("{\n \"text\": \"Hello, welcome to our service.\",\n \"user\": \"abc-123\",\n \"voice\": \"alloy\",\n \"streaming\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{api_base_url}/text-to-audio")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"Hello, welcome to our service.\",\n \"user\": \"abc-123\",\n \"voice\": \"alloy\",\n \"streaming\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/text-to-audio")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"Hello, welcome to our service.\",\n \"user\": \"abc-123\",\n \"voice\": \"alloy\",\n \"streaming\": false\n}"

response = http.request(request)
puts response.read_body
"<string>"

授权

Authorization
string
header
必填

每个请求都通过 API Key 认证:Authorization: Bearer {API_KEY}。应用接口使用应用 API Key,知识库接口使用知识库 API Key(快速开始)。

API Key 应保存在服务端,切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401unauthorized)。

请求体

application/json

文字转语音的请求体。提供 message_idtext 其中之一。

message_id
string<uuid>

要转为语音的消息答案的 ID。同时提供 text 时,优先使用 message_id。消息 ID 从 获取会话历史消息 获取。

text
string

要合成为语音的文本。

user
string

终端用户标识,由你的应用定义,需在应用内唯一。参见 终端用户身份

voice
string

文字转语音使用的声音。可用声音取决于为此应用配置的 TTS 提供商。使用获取应用参数text_to_speech.voice 中的 voice 值作为默认值。

streaming
boolean

为向后兼容而保留,但不产生任何效果。音频是否以流式返回由配置的 TTS 供应商的输出决定,而非此字段。

响应

返回生成的音频文件。Content-Type 头设置为音频 MIME 类型(例如 audio/wavaudio/mp3)。当配置的 TTS 供应商返回流时,音频以 audio/mpeg 分块传输编码方式返回;请求中的 streaming 字段不影响这一行为。

The response is of type file.