API کلید بنائیں، ماڈل چنیں، غیر ہم وقت تخلیقی کام جمع کریں اور اختیاری SSE ترسیل کے ساتھ Chat API کا پہلا مرحلہ بھیجیں۔

یہ فوری رہنما اکاؤنٹ کی ترتیب سے Rivya API کے پہلے تخلیقی کام تک محفوظ ترین مختصر راستہ دکھاتا ہے، اور ساتھ پہلا Chat API مرحلہ بھی شامل کرتا ہے۔

دستاویزات اور مثالوں میں فرضی کلیدیں استعمال کریں۔ اصل API کلید کبھی عوامی کوڈ، اسکرین شاٹ، معاونتی اندراج یا مشترک دستاویز میں چسپاں نہ کریں۔

مثالیں نافذ شدہ Public API v1 معاہدہ بیان کرتی ہیں۔ آزمائش سے پہلے تصدیق کریں کہ متعلقہ تنصیب میں Public 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

مقامی میزبان کے پتے صرف مقامی تیاری کے لیے ہیں۔ عوامی مثالوں میں مقامی خفیہ قدریں استعمال نہیں ہونی چاہییں۔

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": "نرم اسٹوڈیو پس منظر پر مصنوعات کی صاف ادارتی تصویر"
  }'

جواب ایک عوامی کام شناختی نمبر دیتا ہے۔ اسے محفوظ کریں تاکہ بعد میں حالت معلوم کر سکیں۔

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 کے بجائے Chat 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": "مصنوعات کی نئی تصویری مہم کے اجرا کا مختصر منصوبہ لکھیں"
  }'

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: "نرم اسٹوڈیو پس منظر پر مصنوعات کی صاف ادارتی تصویر"
});

اسے اپنانے سے پہلے Rivya TypeScript SDK پڑھیں۔ SDK کے نجی بیٹا میں سرور پر Chat کی مسلسل ترسیل کی معاونت شامل ہے۔

Rivya API کا فوری آغاز