यूज़र गाइड API संदर्भ

शुरुआत करना

अपनी पहली API रिक्वेस्ट करने के लिए ज़रूरी हर चीज़

बेस URL

Moknah आपके इस्तेमाल के तरीके के आधार पर दो तरह के एंडपॉइंट देता है:

स्टैंडर्ड REST API (अलग-अलग अनुरोधों के लिए):

https://moknah.io/api/v1/

रियल-टाइम WebSocket API (लगातार स्ट्रीमिंग के लिए):

wss://moknah.io/api/v1/

प्रमाणीकरण

Moknah API इस्तेमाल करता है API कीज़ ऑथेंटिकेशन के लिए। अपनी API की (key) को इसमें शामिल करें। Authorization का इस्तेमाल करके हेडर वाहक हर HTTP रिक्वेस्ट और WebSocket हैंडशेक के साथ स्कीम।

Authorization: Bearer YOUR_API_KEY

अपनी API की (API Key) प्राप्त करना

  1. अपने अकाउंट में लॉग इन करें मोकनाह डैशबोर्ड
  2. प्रो प्लान सब्सक्राइब करें या संपर्क करें बिक्री एंटरप्राइज़ एक्सेस के लिए।
  3. पर जाएँ API
  4. क्लिक करें API कीज़ मैनेज करें
  5. क्लिक करें नई चाबी
  6. अपनी की (key) को कॉपी करें और सुरक्षित रूप से स्टोर करें।
अपनी चाबी सुरक्षित रखें

अपनी API की (API key) को कभी भी क्लाइंट-साइड कोड या पब्लिक रिपॉजिटरी में उजागर न करें। इसे पासवर्ड की तरह ही सुरक्षित रखें।

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();
    // ऑडियो ब्लॉब का इस्तेमाल करें
    console.log("ऑडियो तैयार हो गया!");
} else {
    const error = await response.json();
    console.error(error);
}

प्रतिक्रिया का प्रारूप

सफलता के जवाब

सफल रिस्पॉन्स एंडपॉइंट के आधार पर अलग-अलग होते हैं:

  • TTS जनरेट करें (POST): पूरा बाइनरी ऑडियो डेटा (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 के लिए उपलब्ध आवाज़ें प्राप्त करें

पोस्ट स्पीच बनाएँ

टेक्स्ट को ऑडियो में बदलें

WSS स्पीच स्ट्रीम करें

रियल-टाइम WebSocket TTS

पोस्ट बोली गई बात को लिखें

ऑडियो फ़ाइल से टेक्स्ट निकालें

WSS स्ट्रीम ट्रांसक्रिप्शन

रियल-टाइम WebSocket STT

API सपोर्ट

API से जुड़े सवालों या समस्याओं के लिए, हमसे संपर्क करें api@moknah.io.