テキストを音声に変換
対象アプリ:Chatflow、Workflow、Agent、チャットボット、レガシー Agent、テキストジェネレーター。
テキストを音声に変換します。任意のテキストを合成するには text を、既存のメッセージの回答を音声化するには message_id を渡します。
curl --request POST \
--url https://{api_base_url}/text-to-audio \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"streaming": false,
"text": "Hello, welcome to our service.",
"user": "abc-123",
"voice": "alloy"
}
'import requests
url = "https://{api_base_url}/text-to-audio"
payload = {
"streaming": False,
"text": "Hello, welcome to our service.",
"user": "abc-123",
"voice": "alloy"
}
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({
streaming: false,
text: 'Hello, welcome to our service.',
user: 'abc-123',
voice: 'alloy'
})
};
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([
'streaming' => false,
'text' => 'Hello, welcome to our service.',
'user' => 'abc-123',
'voice' => 'alloy'
]),
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 \"streaming\": false,\n \"text\": \"Hello, welcome to our service.\",\n \"user\": \"abc-123\",\n \"voice\": \"alloy\"\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 \"streaming\": false,\n \"text\": \"Hello, welcome to our service.\",\n \"user\": \"abc-123\",\n \"voice\": \"alloy\"\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 \"streaming\": false,\n \"text\": \"Hello, welcome to our service.\",\n \"user\": \"abc-123\",\n \"voice\": \"alloy\"\n}"
response = http.request(request)
puts response.read_body"<string>"Authorizations
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
Body
テキストから音声への変換のリクエストボディ。message_id または text のいずれかを指定してください。
回答を音声化するメッセージの ID です。両方が指定された場合、text よりも優先されます。メッセージ ID は 会話履歴メッセージ一覧を取得 から取得します。
後方互換性のために受け付けられますが、効果はありません。音声がストリーミングされるかどうかは、設定された TTS プロバイダーの出力によって決まり、このフィールドでは制御されません。
音声に合成するテキストです。
エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。エンドユーザーの識別 を参照してください。
テキスト読み上げに使用する音声。利用可能な音声は、このアプリに設定された TTS プロバイダーによって異なります。デフォルトにはアプリケーションのパラメータ情報を取得 → text_to_speech.voice の voice 値を使用してください。
Response
生成された音声を返します。Content-Type ヘッダーはプロバイダーが返す音声コンテナ形式を反映し、認識可能な場合はレスポンスのバイト列から検証されます。
レスポンスボディは AAC、FLAC、MP4、MP3、Ogg、WAV、WebM のいずれかです。認識できない出力には、プロバイダーが宣言した形式が設定されます。宣言がない場合は audio/mpeg になります。
プロバイダーがストリームを返す場合はチャンク転送エンコーディングで配信されます。リクエストの streaming フィールドはこの動作を制御しません。
The response is of type file.
Was this page helpful?
curl --request POST \
--url https://{api_base_url}/text-to-audio \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"streaming": false,
"text": "Hello, welcome to our service.",
"user": "abc-123",
"voice": "alloy"
}
'import requests
url = "https://{api_base_url}/text-to-audio"
payload = {
"streaming": False,
"text": "Hello, welcome to our service.",
"user": "abc-123",
"voice": "alloy"
}
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({
streaming: false,
text: 'Hello, welcome to our service.',
user: 'abc-123',
voice: 'alloy'
})
};
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([
'streaming' => false,
'text' => 'Hello, welcome to our service.',
'user' => 'abc-123',
'voice' => 'alloy'
]),
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 \"streaming\": false,\n \"text\": \"Hello, welcome to our service.\",\n \"user\": \"abc-123\",\n \"voice\": \"alloy\"\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 \"streaming\": false,\n \"text\": \"Hello, welcome to our service.\",\n \"user\": \"abc-123\",\n \"voice\": \"alloy\"\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 \"streaming\": false,\n \"text\": \"Hello, welcome to our service.\",\n \"user\": \"abc-123\",\n \"voice\": \"alloy\"\n}"
response = http.request(request)
puts response.read_body"<string>"