Rivya API

Rivya की मल्टीमोडल मॉडल लेयर पर अपने उत्पाद बनाएं

Rivya API उत्पाद टीमों को अपने ऐप से Rivya मॉडल कॉल करने का सार्वजनिक, खाते पर आधारित तरीका देता है। असिंक्रोनस इमेज, वीडियो और ऑडियो जॉब से शुरुआत करें, चैट समर्थित मॉडल के लिए वैकल्पिक SSE streaming वाले चैट API टर्न जोड़ें और बिलिंग को उसी Rivya क्रेडिट वॉलेट में रखें।
API दस्तावेज़ पढ़ेंAPI key बनाएं

क्विकस्टार्ट का प्रारूप

मॉडल लेयर

डायनेमिक कैटलॉग

बिलिंग

साझा क्रेडिट

पहला वर्जन

जॉब + चैट

एक्सेस

API keys

मेथडPOST
एंडपॉइंट/api/v1/generations

वास्तविक रिक्वेस्ट के लिए Rivya API key और खाते में उपलब्ध क्रेडिट चाहिए। सार्वजनिक उदाहरण प्लेसहोल्डर गोपनीय keys का उपयोग करते हैं और बिना पहचान के मॉडल कॉल नहीं करते।

रिक्वेस्ट
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": 20,
  "result": null,
  "error": null
}

शुरुआती सुविधाएं

एक सार्वजनिक API लेयर जो Rivya उत्पाद के साथ तालमेल में रहती है

API को Rivya उत्पाद की एक सतह के रूप में बनाया गया है। यह Rivya मॉडल ID, Rivya क्रेडिट, सार्वजनिक टास्क स्टेट और मॉडल कैटलॉग से जुड़े दस्तावेज़ों का उपयोग करता है।

इमेज जनरेशन API

प्रॉम्प्ट और समर्थित मॉडल पैरामीटर के साथ इमेज जॉब सबमिट करें, फिर सार्वजनिक नतीजों के लिए पोल करें।

वीडियो जनरेशन API

Studio में इस्तेमाल होने वाले टास्क और क्रेडिट कंट्रोल के साथ असिंक्रोनस वीडियो जॉब चलाएं।

ऑडियो जनरेशन API

उसी खाते, बैलेंस और हिस्ट्री सीमा के जरिए API से उपलब्ध ऑडियो मॉडल इस्तेमाल करें।

साझा क्रेडिट वॉलेट

API कॉल और Studio उपयोग उसी Rivya बैलेंस से क्रेडिट लेते हैं, जिसमें आरक्षित क्रेडिट और विफलता प्रबंधन शामिल हैं।

शुरुआती रास्ता

खाते से पहली API रिक्वेस्ट तक

01

एक key बनाएं

साइन इन करें, Settings में API Keys खोलें, सीमित दायरे वाली key बनाएं और पूरी secret key को तुरंत सुरक्षित रखें।

02

एक मॉडल चुनें

सबमिट करने से पहले मॉडल ID, पैरामीटर, चैट क्षमताएं और इनपुट readiness देखने के लिए API मॉडल संदर्भ पढ़ें या /api/v1/models कॉल करें।

03

सबमिट, पोल या सब्सक्राइब करें

एक idempotent जनरेशन रिक्वेस्ट भेजें, सार्वजनिक टास्क एंडपॉइंट को पोल करें, जनरेशन callback के लिए signed webhooks इस्तेमाल करें या वैकल्पिक SSE streaming के साथ चैट API टर्न भेजें।

वर्जन सीमा

स्पष्ट दायरा, कोई छिपा हुआ वादा नहीं

लैंडिंग पेज भविष्य की सुविधाओं का उल्लेख कर सकता है, लेकिन मौजूदा उत्पाद टेक्स्ट से ऐसा नहीं लगना चाहिए कि अधूरे API पहले से लाइव हैं।

Chat API

उपलब्ध

API से बनाए गए session, खाते के क्रेडिट और वैकल्पिक Files API इमेज attachment के साथ non-streaming और SSE streaming टर्न उपलब्ध हैं।

Files API

उपलब्ध

संदर्भ इमेज, वीडियो और ऑडियो अपलोड के लिए उपलब्ध। जब किसी मॉडल पेज पर params.referenceMediaItems मांगा जाए, तो जनरेशन से पहले इसका उपयोग करें।

उपयोगकर्ता webhooks

उपलब्ध

उन प्रोडक्शन इंटीग्रेशन के लिए उपलब्ध जिन्हें सफल या विफल जनरेशन टास्क के signed callback चाहिए।

ऑनलाइन डिबगर

रिक्वेस्ट का प्रीव्यू देखें, फिर अपनी API key से चलाएं

हर विज़िटर के लिए डिबगर mock mode में शुरू होता है। जनरेशन selector में वे non-chat मॉडल दिखते हैं जिन्हें फाइल अपलोड किए बिना परखा जा सकता है, जबकि Files panel साइन इन किए हुए उपयोगकर्ताओं को अस्थायी API key से /api/v1/files जांचने देता है। चैट उदाहरण API दस्तावेज़ों में उपलब्ध हैं।

खाते की स्थिति

खाता जांचा जा रहा है

सक्रिय key का उपसर्ग

पहले एक key बनाएं

मौजूदा क्रेडिट

जांचने के लिए साइन इन करें

Mock प्रीव्यूलाइव सार्वजनिक APIकोई सक्रिय API key नहीं

Mock mode कभी भी मॉडल कॉल नहीं करता और क्रेडिट खर्च नहीं करता।

इस key को केवल इस रिक्वेस्ट के लिए पेस्ट करें। रिफ्रेश होने के बाद डिबगर इसे स्टोर नहीं करता।

Files API अपलोड टेस्ट

POST /api/v1/files के जरिए संदर्भ मीडिया अपलोड करें, फिर लौटे हुए URL और duration token को संदर्भ इनपुट समर्थित मॉडल के params.referenceMediaItems में कॉपी करें।

Mock कभी अपलोड नहीं करताLive में /api/v1/files का उपयोग होता है

चुना गया मॉडल अनुमत MIME प्रकार, आकार और अवधि नियम तय करता है। Live अपलोड के लिए आपकी अस्थायी API key चाहिए और यह वास्तविक अपलोड सेवा कॉल कर सकता है।

API key बनाएं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
}
Files API रिस्पॉन्स
{
  "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"
      }
    ]
  }
}

टास्क स्टेट

अनुमानित बेस क्रेडिट

1

स्टेटस

queued

API दस्तावेज़

ऑथेंटिकेशन, रिक्वेस्ट body, रिस्पॉन्स, idempotency, मॉडल पैरामीटर और error codes पढ़ें।

दस्तावेज़ खोलें

API key प्रबंधन

सुरक्षित Settings क्षेत्र से API keys बनाएं, एक बार कॉपी करें, revoke करें और rotate करें।

Keys प्रबंधित करें

ऑनलाइन डिबगिंग

पहले mock उदाहरण इस्तेमाल करें; वास्तविक डिबगिंग के लिए लॉगिन, API key और खाते में क्रेडिट चाहिए।

Flow का प्रीव्यू देखें