एक कुंजी बनाएँ
साइन इन करें, सेटिंग्स में API कुंजियाँ खोलें, सीमित दायरे वाली कुंजी बनाएँ और पूरी गुप्त कुंजी को तुरंत सुरक्षित रखें।
Rivya API
क्विकस्टार्ट का प्रारूप
मॉडल लेयर
डायनेमिक कैटलॉग
बिलिंग
साझा क्रेडिट
पहला वर्जन
जॉब + चैट
एक्सेस
API कुंजियाँ
वास्तविक रिक्वेस्ट के लिए Rivya API कुंजी और खाते में उपलब्ध क्रेडिट चाहिए। सार्वजनिक उदाहरणों में केवल नमूना गुप्त मान होते हैं और वे बिना प्रमाणीकरण के मॉडल अनुरोध नहीं भेजते।
curl https://rivya.ai/api/v1/generations \
-H "Authorization: Bearer rvya_sk_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: demo-job-001" \
-d '{
"model": "z-image",
"prompt": "Editorial product photo on a clean studio set"
}'{
"id": "task_public_id",
"status": "queued",
"model": "z-image",
"reserved_credits": 1,
"result": null,
"error": null
}ऑनलाइन डिबगर
हर विज़िटर के लिए डिबगर मॉक मोड में शुरू होता है। जनरेशन चयन में वे गैर-चैट मॉडल दिखते हैं जिन्हें फ़ाइल अपलोड किए बिना परखा जा सकता है, जबकि फ़ाइल पैनल साइन इन किए हुए उपयोगकर्ताओं को अस्थायी API कुंजी से `/api/v1/files` जाँचने देता है। चैट उदाहरण API दस्तावेज़ों में उपलब्ध हैं।
खाते की स्थिति
खाता जाँचा जा रहा है
सक्रिय कुंजी का उपसर्ग
पहले एक कुंजी बनाएँ
मौजूदा क्रेडिट
जाँचने के लिए साइन इन करें
मॉक मोड कभी भी मॉडल अनुरोध नहीं भेजता और क्रेडिट खर्च नहीं करता।
इस कुंजी को केवल इस रिक्वेस्ट के लिए पेस्ट करें। पृष्ठ ताज़ा होने के बाद डिबगर इसे सहेजकर नहीं रखता।
Files API अपलोड टेस्ट
`POST /api/v1/files` के जरिए संदर्भ मीडिया अपलोड करें, फिर लौटे हुए URL और `duration token` को संदर्भ इनपुट समर्थित मॉडल के `params.referenceMediaItems` में कॉपी करें।
चुना गया मॉडल अनुमत MIME प्रकार, आकार और अवधि के नियम तय करता है। लाइव अपलोड के लिए आपकी अस्थायी API कुंजी चाहिए और यह वास्तविक अपलोड सेवा को अनुरोध भेज सकता है।
{
"model": "z-image",
"prompt": "साफ स्टूडियो सेट पर एडिटोरियल शैली की उत्पाद फोटो",
"params": {
"aspect_ratio": "1:1"
}
}{
"id": "mock_task_001",
"status": "queued",
"model": "z-image",
"reserved_credits": 1,
"final_credits": 0,
"result": null,
"error": null
}{
"id": "file_mock_001",
"object": "file",
"kind": "image",
"file_name": "reference.png",
"mime_type": "image/png",
"size_bytes": 245760,
"url": "https://media.example/reference.png",
"duration_seconds": null,
"duration_token": null,
"created_at": "2026-05-11T00:00:00.000Z",
"expires_at": null
}{
"params": {
"referenceMediaItems": [
{
"url": "https://media.example/reference.png",
"kind": "image",
"name": "reference.png",
"mimeType": "image/png",
"sizeBytes": 245760
}
]
}
}टास्क स्टेट
अनुमानित बेस क्रेडिट
1
स्टेटस
queued
शुरुआती रास्ता
साइन इन करें, सेटिंग्स में API कुंजियाँ खोलें, सीमित दायरे वाली कुंजी बनाएँ और पूरी गुप्त कुंजी को तुरंत सुरक्षित रखें।
सबमिट करने से पहले मॉडल ID, पैरामीटर, चैट क्षमताएँ और इनपुट की तैयारी देखने के लिए API मॉडल संदर्भ पढ़ें या `/api/v1/models` कॉल करें।
दोहराव-रोधी जनरेशन रिक्वेस्ट भेजें, सार्वजनिक कार्य एंडपॉइंट पर स्थिति जाँचें, जनरेशन कॉलबैक के लिए हस्ताक्षरित वेबहुक इस्तेमाल करें या वैकल्पिक SSE स्ट्रीमिंग के साथ Chat API संदेश भेजें।
शुरुआती सुविधाएँ
API Rivya उत्पाद का हिस्सा है। यह Rivya मॉडल ID, Rivya क्रेडिट, सार्वजनिक टास्क स्टेट और मॉडल कैटलॉग से जुड़े दस्तावेज़ों का उपयोग करता है।
प्रॉम्प्ट और समर्थित मॉडल पैरामीटर के साथ इमेज कार्य सबमिट करें, फिर सार्वजनिक नतीजों के लिए उसकी स्थिति जाँचें।
Studio में इस्तेमाल होने वाले कार्य और क्रेडिट नियंत्रण के साथ असिंक्रोनस वीडियो जनरेशन चलाएँ।
उसी खाते, क्रेडिट शेष और इतिहास की सीमाओं के साथ API से उपलब्ध ऑडियो मॉडल इस्तेमाल करें।
API कॉल और Studio उपयोग उसी Rivya बैलेंस से क्रेडिट लेते हैं, जिसमें आरक्षित क्रेडिट और विफलता प्रबंधन शामिल हैं।
वर्जन सीमा
यह पेज उपलब्ध API क्षमताओं और भविष्य में जुड़ने वाली सुविधाओं को अलग-अलग दिखाता है, ताकि आप आज उपलब्ध सुविधाओं के आधार पर योजना बना सकें।
API से बनाए गए सत्र, खाते के क्रेडिट और वैकल्पिक Files API इमेज अटैचमेंट के साथ बिना स्ट्रीमिंग और SSE स्ट्रीमिंग—दोनों तरह के संदेश उपलब्ध हैं।
संदर्भ इमेज, वीडियो और ऑडियो अपलोड के लिए उपलब्ध। जब किसी मॉडल पेज पर params.referenceMediaItems मांगा जाए, तो जनरेशन से पहले इसका उपयोग करें।
उन प्रोडक्शन इंटीग्रेशन के लिए उपलब्ध जिन्हें सफल या विफल जनरेशन कार्य के हस्ताक्षरित कॉलबैक चाहिए।
प्रमाणीकरण, रिक्वेस्ट बॉडी, रिस्पॉन्स, idempotency, मॉडल पैरामीटर और त्रुटि कोड के बारे में पढ़ें।
दस्तावेज़ खोलेंएक API कुंजी बनाएँ और उसे एक बार कॉपी करें। कुंजी बदलने के लिए सुरक्षित सेटिंग्स में नई कुंजी बनाएँ और पुरानी कुंजी रद्द करें।
कुंजियाँ प्रबंधित करेंपहले मॉक उदाहरण इस्तेमाल करें; वास्तविक डिबगिंग के लिए साइन इन, API कुंजी और खाते में क्रेडिट चाहिए।
प्रवाह का प्रीव्यू देखें