آغاز کریں
اپنی پہلی API درخواست کرنے کے لیے آپ کو جس چیز کی بھی ضرورت ہے
بنیادی URLs
Moknah آپ کی ضرورت کے مطابق دو قسم کے اینڈ پوائنٹس فراہم کرتا ہے:
اسٹینڈرڈ REST API (انفرادی درخواستوں کے لیے):
https://moknah.io/api/v1/
ریئل ٹائم WebSocket API (مسلسل اسٹریمنگ کے لیے):
wss://moknah.io/api/v1/
تصدیق
Moknah API تصدیق کے لیے API کلیدیں استعمال کرتا ہے۔ اپنی API کلید کو Authorization ہیڈر میں
Bearer اسکیم کے ساتھ ہر HTTP درخواست اور WebSocket ہینڈ شیک میں شامل کریں۔
Authorization: Bearer YOUR_API_KEY
اپنی API کلید حاصل کرنا
- اپنے اکاؤنٹ میں لاگ ان کریں: Moknah ڈیش بورڈ
- Pro پلان سبسکرائب کریں یا انٹرپرائز رسائی کے لیے رابطہ کریں: سیلز ۔
- یہاں جائیں: API
- کلک کریں: API کلیدوں کا انتظام کریں
- کلک کریں: نئی کلید
- اپنی کلید کاپی کریں اور محفوظ طریقے سے اسٹور کریں
کلائنٹ سائیڈ کوڈ یا عوامی ریپوزٹریز میں اپنی API کلید کو کبھی ظاہر نہ کریں۔ اسے پاس ورڈ کی طرح محفوظ رکھیں۔
مختصر HTTP مثال
اسٹینڈرڈ REST API کا استعمال کرتے ہوئے متن سے آواز تیار کرنے کی ایک مکمل مثال یہ ہے:
curl -X POST "https://moknah.io/api/v1/tts/generate/" \
-H "Authorization: Bearer your_api_key" \
-H "Content-Type: application/json" \
-d '{
"text": "مرحبا بك في منصة مكنة",
"voice_id": 1
}' \
--output speech.mp3
import requests
response = requests.post(
"https://moknah.io/api/v1/tts/generate/",
headers={
"Authorization": f"Bearer your_api_key",
},
json={
"text": "مرحبا بك في منصة مكنة",
"voice_id": 1
}
)
if response.status_code == 200:
with open("speech.mp3", "wb") as f:
f.write(response.content)
print("آڈیو محفوظ ہو گئی!")
else:
print(f"خرابی: {response.json()}")
const response = await fetch(
'https://moknah.io/api/v1/tts/generate/',
{
method: 'POST',
headers: {
'Authorization': 'Bearer your_api_key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
text: 'مرحبا بك في منصة مكنة',
voice_id: 1
})
}
);
if (response.ok) {
const blob = await response.blob();
// آڈیو blob استعمال کریں
console.log("آڈیو تیار ہو گئی!");
} else {
const error = await response.json();
console.error(error);
}
رسپانس فارمیٹ
کامیاب رسپانسز
کامیاب رسپانسز اینڈ پوائنٹ کے لحاظ سے مختلف ہوتے ہیں:
- TTS جنریٹ (POST): مطلوبہ output_format میں مکمل بائنری آڈیو ڈیٹا واپس کرتا ہے (بطور ڈیفالٹ audio/mpeg)
- TTS اسٹریم (WSS): بائنری MP3 کے حصے جیسے جیسے بنتے جاتے ہیں انہیں مسلسل اسٹریم کرتا ہے
- دیگر اینڈ پوائنٹس: منظم JSON ڈیٹا فراہم کرتا ہے
ریٹ لمٹ ہیڈرز (صرف HTTP)
ہر HTTP ریسپانس میں ریٹ لمٹ کی معلومات شامل ہوتی ہیں (WebSockets کنکشن بند کر کے حدود لاگو کرتے ہیں):
| ہیڈر | تفصیل |
|---|---|
| RateLimit-Limit | فی منٹ زیادہ سے زیادہ درخواستیں |
| RateLimit-Remaining | موجودہ ونڈو میں باقی ماندہ درخواستیں |
| RateLimit-Reset | لمٹ ری سیٹ ہونے کا Unix ٹائم اسٹیمپ |
| Moknah-Credits-Remaining | آپ کا باقی ماندہ کریڈٹ بیلنس |
عام ایرر کوڈز
| کوڈ | قسم | تفصیل |
|---|---|---|
| 400 | INVALID_REQUEST |
غلط پیرامیٹرز یا خراب JSON فارمیٹ |
| 401 | UNAUTHORIZED |
غلط یا غائب API کلید |
| 402 | INSUFFICIENT_CREDITS |
اکاؤنٹ میں کافی کریڈٹس نہیں ہیں |
| 429 | RATE_LIMIT_EXCEEDED |
بہت زیادہ درخواستیں (HTTP) |
| 4290 | CONCURRENT_LIMIT |
بہت زیادہ فعال کنکشنز (WSS) |
| 500 | INTERNAL_SERVER_ERROR |
سرور کا ایرر |
تفصیلی ایرر ہینڈلنگ گائیڈنس کے لیے خرابیاں صفحہ دیکھیں۔
اگلے مراحل
اب جب کہ آپ نے سیٹ اپ مکمل کر لیا ہے، دستیاب اینڈ پوائنٹس دریافت کریں:
TTS کے لیے دستیاب آوازیں حاصل کریں
متن کو آڈیو میں تبدیل کریں
ریئل ٹائم WebSocket TTS
آڈیو فائل سے متن اخذ کریں
ریئل ٹائم WebSocket STT
API سے متعلق سوالات یا مسائل کے لیے، ہم سے یہاں رابطہ کریں api@moknah.io.