API कुंजियां, खाता क्रेडिट और वैकल्पिक SSE स्ट्रीमिंग के साथ अपने उत्पाद से Rivya निर्माण और बातचीत मॉडल कॉल करने के लिए Rivya API v1 इस्तेमाल करें.

Rivya API v1 अपने उत्पाद से Rivya की समर्थित मॉडल क्षमताएँ इस्तेमाल करने का डेवलपर एकीकरण अनुबंध है—बशर्ते व्यवस्था में सार्वजनिक API चालू हो और खाते को पहुँच मिली हो।

लागू एकीकरण अनुबंध में असिंक्रोनस इमेज, वीडियो और ऑडियो जनरेशन के साथ बिना स्ट्रीम या SSE स्ट्रीमिंग जवाब वाला Chat API संदेश शामिल है। इसमें Rivya मॉडल ID, खाते के क्रेडिट, जनरेशन की सार्वजनिक कार्य ID और Chat API के सर्वर-पक्षीय सत्र इस्तेमाल होते हैं। किसी रूट का दस्तावेज़ में होना यह वादा नहीं है कि हर वातावरण, खाता या सूचीबद्ध मॉडल उसे कॉल कर सकता है; एकीकरण से पहले पहुंच और मॉडल की तैयारी जांचें।

API किसके लिए है

API तब इस्तेमाल करें जब आप:

अपने ऐप से चित्र, वीडियो या ध्वनि निर्माण काम भेजें करना चाहते हैं
बिना स्ट्रीम वाला या स्ट्रीमिंग बातचीत बातचीत के दौर भेजना और API-तैयार किया गया बातचीत सत्र आगे बढ़ना करना चाहते हैं
बिल को उसी Rivya खाता क्रेडिट क्रेडिट बटुआ में रखना चाहते हैं
सार्वजनिक कार्य ID से स्थिति पोल करना चाहते हैं
सुरक्षित जनरेशन अनुरोधों के लिए आइडेम्पोटेंट दोबारा प्रयास करना चाहते हैं
Studio और API उपयोग को उसी खाता सीमा के अंदर रखना चाहते हैं

API, Rivya उत्पाद की एक परत है। सार्वजनिक जवाब केवल Rivya के नाम और सार्वजनिक फ़ील्ड इस्तेमाल करते हैं।

मौजूदा संस्करण दायरा

लागू किए गए v1 एंडपॉइंट में शामिल हैं:

GET /api/v1/models
POST /api/v1/generations
POST /api/v1/files
GET /api/v1/files/{fileId}
POST /api/v1/chat/completions
GET /api/v1/chat/sessions
GET /api/v1/chat/sessions/{sessionId}
GET /api/v1/generations/{taskId}
GET /api/v1/credits
GET /api/v1/webhooks
POST /api/v1/webhooks
GET /api/v1/webhook-events
GET /api/v1/openapi.json

मौजूदा एकीकरण अनुबंध में असिंक्रोनस जनरेशन नतीजों के प्रमाणित वेबहुक, बातचीत API और सर्वर-पक्ष की स्ट्रीमिंग का समर्थन करने वाला TypeScript SDK परीक्षण संस्करण शामिल है। वेबहुक कॉल के लिए व्यवस्था में वेबहुक सुविधा और सार्वजनिक API दोनों चालू होने चाहिए।

पहचान सत्यापन

जनरेशन, स्थिति और क्रेडिट एंडपॉइंट के लिए यह जरूरी है:

Authorization: Bearer rvya_sk_...

API कुंजियां सेटिंग से कुंजियां तैयार और घूमता करें। निर्माण में कुंजी इस्तेमाल करने से पहले API पहचान सत्यापन पढ़ें।

बिल मॉडल

API कॉल वही Rivya खाता क्रेडिट इस्तेमाल करते हैं जो Studio इस्तेमाल करता है।

जनरेशन कार्य शुरू होने पर क्रेडिट आरक्षित या खर्च करते हैं। चैट चरण मॉडल कॉल से पहले क्रेडिट आरक्षित करते हैं और सहायक संदेश सहेजे जाने पर टोकन उपयोग के अनुसार अंतिम क्रेडिट तय करते हैं। अगर जनरेशन या चैट चरण मौजूदा Rivya विफलता नियम के तहत विफल हो, तो वही वापसी प्रक्रिया लागू होती है।

उपयोगकर्ता को दिखाई देने वाला क्रेडिट बटुआ मॉडल के लिए API क्रेडिट और Rivya में क्रेडिट और बिल पढ़ें।

पहला एकीकरण क्रम

सेटिंग में API कुंजी तैयार करें।
सार्वजनिक मॉडल ID चुनने के लिए सूची API मॉडल कॉल करें।
मॉडल के मापदंड के लिए मॉडल API संदर्भ पढ़ें।
अगर मॉडल को संदर्भ मीडिया चाहिए, तो Files API से अपलोड करें।
जनरेशन बनाएं से कार्य भेजें।
कार्य सफल या विफल होने तक जनरेशन स्थिति को पोल करें। अगर तैनाती और खाते के लिए वेबहुक सक्रिय हैं, तो API वेबहुक के जरिए साइन किए गए पूर्णता इवेंट प्राप्त किए जा सकते हैं।
चैट मॉडल के लिए जनरेशन एंडपॉइंट के बजाय Chat API इस्तेमाल करें। चैट के इमेज अटैचमेंट में Files API की file_id वैल्यू का संदर्भ होना चाहिए।

Rivya API परिचय

API किसके लिए है

मौजूदा संस्करण दायरा

पहचान सत्यापन

बिल मॉडल

पहला एकीकरण क्रम

संबंधित पेज

विषय-सूची