API कुंजी बनाएं, मॉडल चुनें, असिंक्रोनस जनरेशन कार्य भेजें और वैकल्पिक SSE स्ट्रीमिंग के साथ Chat API में संदेश भेजें।

यह त्वरित शुरुआत खाता व्यवस्था से Rivya API के पहले जनरेशन कार्य तक सबसे छोटा सुरक्षित मार्ग दिखाती है, साथ ही बातचीत API का पहला दौर भी।

दस्तावेज़ और उदाहरण में नमूना कुंजियां इस्तेमाल करें। वास्तविक API कुंजी को सार्वजनिक कोड, स्क्रीनशॉट, सहायता टिकट या साझा दस्तावेज़ में कभी न चिपकाएं।

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

1. API कुंजी बनाएं

API कुंजी सेटिंग खोलें, कुंजी बनाएं, पूरा गुप्त मान केवल एक बार कॉपी करें और उसे अपने सर्वर-पक्ष के परिवेश में सुरक्षित रखें।

शुरुआत के लिए सुझाई गई अनुमतियां:

models:read
generations:create
generations:read
files:create
files:read
credits:read
webhooks:manage
chat:create
chat:read

2. मूल URL की पुष्टि करें

जनरेशन API का मूल URL इस्तेमाल करें:

https://rivya.ai

localhost URL केवल स्थानीय विकास के लिए हैं। सार्वजनिक उदाहरणों में स्थानीय गुप्त मान इस्तेमाल नहीं करने चाहिए।

3. मॉडल सूची करें

curl https://rivya.ai/api/v1/models

जनरेशन तैयार करते समय जवाब के id फ़ील्ड को model के मान के रूप में इस्तेमाल करें।

4. जनरेशन भेजें

curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-001" \
  -d '{
    "model": "z-image",
    "prompt": "A clean editorial product image on a soft studio background"
  }'

जवाब एक सार्वजनिक कार्य ID लौटाता है। इसे सहेजें, ताकि बाद में स्थिति पोल की जा सके।

5. स्थिति पोल करें

curl https://rivya.ai/api/v1/generations/task_public_id \
  -H "Authorization: Bearer rvya_sk_..."

स्थिति के मान ये हैं:

queued
processing
succeeded
failed

6. क्रेडिट जांचें

curl https://rivya.ai/api/v1/credits \
  -H "Authorization: Bearer rvya_sk_..."

परीक्षण से पहले या बाद में खाते के मौजूदा क्रेडिट शेष की पुष्टि करने के लिए इसका इस्तेमाल करें।

7. वैकल्पिक: वेबहुक जोड़ें

व्यवस्था और खाते के लिए वेबहुक पहुँच चालू हो और आपका सर्वर प्रमाणित HTTPS कॉलबैक ले सकता हो, तभी वेबहुक एंडपॉइंट बनाएँ:

curl https://rivya.ai/api/v1/webhooks \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production webhook",
    "url": "https://example.com/rivya/webhook",
    "event_types": ["generation.succeeded", "generation.failed"]
  }'

जवाब में मिला एक बार दिखाई देने वाला signing_secret सुरक्षित रखें और पेलोड पर भरोसा करने से पहले हर डिलीवरी सत्यापित करें।

8. वैकल्पिक: बातचीत बातचीत का दौर भेजें

बातचीत मॉडल के लिए POST /api/v1/generations के बजाय बातचीत API कॉल करें:

curl https://rivya.ai/api/v1/chat/completions \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-chat-001" \
  -d '{
    "model": "claude-sonnet-5-chat",
    "message": "Write a concise launch plan for a new product image campaign"
  }'

API से बनाए गए सत्र को जारी रखने के लिए जवाब में मिला session_id इस्तेमाल करें। इमेज अटैचमेंट में Files API की file_id वैल्यू का संदर्भ होना चाहिए।

वैकल्पिक: TypeScript SDK परीक्षण संस्करण इस्तेमाल करें

सर्वर-पक्ष का TypeScript एकीकरण SDK के स्थानीय परीक्षण संस्करण का उपयोग कर सकता है:

import { RivyaClient } from "@rivya/sdk";

const rivya = new RivyaClient({
  apiKey: process.env.RIVYA_API_KEY
});

const generation = await rivya.generations.create({
  model: "z-image",
  prompt: "A clean editorial product image on a soft studio background"
});

इसे अपनाने से पहले Rivya TypeScript SDK पढ़ें। SDK निजी परीक्षण संस्करण में सर्वर-पक्ष का बातचीत स्ट्रीमिंग समर्थन शामिल करता है।

Rivya API त्वरित शुरुआत