API ریفرنس
آوازوں کی فہرست
TTS کے لیے دستیاب آوازیں حاصل کریں
POST
/api/v1/voices/
ان تمام آوازوں کی فہرست واپس کرتا ہے جنہیں تصدیق شدہ صارف کو ٹیکسٹ ٹو اسپیچ API کے ساتھ استعمال کرنے کی اجازت ہے۔
تصدیق
اپنی API کلید کو Authorization ہیڈر میں بطور Bearer YOUR_API_KEY شامل کریں۔
درخواست کی باڈی (Request Body)
| پیرامیٹر | لازمی | قسم | تفصیل |
|---|---|---|---|
| language | اختیاری | اسٹرنگ (string) | آوازوں کے ناموں اور بیج کی قدروں کی زبان، مثلاً ar، fr یا zh-hans (URL میں ?language= کے طور پر بھی قبول ہے)۔ جس آواز کا اس زبان میں متن نہ ہو وہ انگریزی میں دکھائی جاتی ہے، اور کوڈ نہ ہونے یا غیر معاون ہونے پر بھی انگریزی۔ استعمال شدہ زبان Content-Language جوابی ہیڈر میں ظاہر ہوتی ہے۔ |
| engine | اختیاری | اسٹرنگ (string) | آپ کی API کلید صرف اپنی قسم کی آوازیں دکھاتی ہے (معیاری یا ایڈوانسڈ، جو کلید بناتے وقت منتخب کی گئی)۔ اگر آپ engine بھیجیں تو وہ کلید کی قسم سے میل کھانا چاہیے۔ |
جواب
| فیلڈ | قسم | تفصیل |
|---|---|---|
| voice_id | عددی (integer) | منفرد آواز کا شناخت کار |
| voice_name | اسٹرنگ (string) | آواز کا ظاہری نام |
| voice_sample_url | اسٹرنگ (string) | آواز کے نمونے کی آڈیو فائل کا URL |
| voice_fees | اعشاری عدد (float) | اس آواز کو استعمال کرنے کی فیس (0 کا مطلب مفت ہے) |
| voice_badges | آبجیکٹ (object) | آواز کے لیے اضافی میٹا ڈیٹا، مثلاً زبان، جنس، عمر، استعمال کی نوعیت |
| voice_engine | اسٹرنگ (string) | standard یا advanced۔ اسٹینڈرڈ انجن کی آوازیں mode استعمال کرتی ہیں؛ ایڈوانسڈ انجن کی آوازیں context، setting، style اور pace استعمال کرتی ہیں۔ دیکھیں انجنز اور موڈز. |
مثال
curl "https://moknah.io/api/v1/voices/" \
-H "Authorization: Bearer YOUR_API_KEY"
import requests
response = requests.post(
"https://moknah.io/api/v1/voices/",
headers={"Authorization": "Bearer YOUR_API_KEY"}
)
voices = response.json()
for voice in voices:
print(voice["voice_name"], voice["voice_sample_url"])
const response = await fetch(
'https://moknah.io/api/v1/voices/',
{
headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
}
);
const voices = await response.json();
console.log(voices);
جواب کی مثال
[
{
"voice_id": 1328,
"voice_name": "Adnan",
"voice_sample_url": "https://storage.moknah.io/media/voice_samples/Adnan.mp3",
"voice_fees": 0.0,
"voice_badges": {
"language": "Arabic",
"gender": "Male",
"age": "Young Adult",
"use_case": "Documentary, Audiobook, Article",
},
"voice_engine": "standard"
}
]
API سپورٹ
API سے متعلق سوالات یا مسائل کے لیے، ہم سے یہاں رابطہ کریں api@moknah.io.