تبدیل متن به صوت
تبدیل متن به صوت
این سرویس (endpoint) برای تبدیل متن به فایل صوتی (MP3) با استفاده از دستیار (Agent) استفاده میشود. در صورتی که دستیار انتخابشده قابلیت تبدیل متن به گفتار (TTS) داشته باشد، خروجی به صورت فایل صوتی برگردانده میشود.
برای استفاده از این سرویس، ارسال پارامترهای
message_idوtextدر بدنه درخواست الزامی است.
مسیر سرویس
POST /api/v1/core/agent/{agent_pk}/text_to_audio
پارامترهای مسیر (Path Parameters)
| نام | نوع | توضیحات |
|---|---|---|
agent_pk | عدد صحیح | شناسه دستیار (Agent) |
هدرها (Headers)
| هدر | مقدار | توضیح |
|---|---|---|
Authorization | Token api-token | توکن احراز هویت |
Content-Type | application/json | نوع داده ارسالی (JSON) |
نحوه استفاده
- مطمئن شوید که دستیار انتخابشده (
agent_pk) از تبدیل متن به گفتار پشتیبانی میکند. - در بدنه درخواست (Request Body)،
message_idوtextرا ارسال کنید. - در صورت موفقیت، پاسخ به صورت فایل MP3 (
audio/mpeg) برگردانده میشود.
ساختار بدنه درخواست (Request Body)
{
"message_id": "string",
"text": "string"
}
| نام فیلد | نوع | الزامی | توضیحات |
|---|---|---|---|
message_id | رشته (string) | بله | شناسه یکتا برای پیام مرتبط |
text | رشته (string) | بله | متنی که باید به صوت تبدیل شود |
مثال با CURL
curl --location 'https://app.houshyar24.ir/api/v1/core/agent/1/text_to_audio'
--header 'Authorization: Token <your-token>'
--header 'Content-Type: application/json'
--data '{
"message_id": "123e4567-e89b-12d3-a456-426614174000",
"text": "سلام! امروز حالت چطوره؟"
}'
پاسخها (Responses)
موفق (200)
- برمیگرداند: فایل صوتی با فرمت
audio/mpeg(MP3) در بدنه پاسخ.
نمونه توضیح در مستندات:
{
"content_type": "audio/mpeg",
"detail": "Binary MP3 audio stream returned in the response body."
}
خطا (400) – عامل پشتیبانی نمیکند
"The Agent You Choose Does not have Text to Speech Option"
خطا (404) – دستیار یافت نشد
"The Agent Does Not Exists"
خطا (408) – درخواست بیش از حد طول کشیده
"The request took too long to complete. Please try again later."