API key create کریں، model choose کریں، asynchronous generation job submit کریں، اور optional SSE streaming کے ساتھ Chat API turn send کریں۔

یہ quickstart account setup سے ایک Rivya API generation job تک سب سے مختصر safe path دکھاتا ہے، ساتھ ہی پہلا Chat API turn بھی۔

Docs اور examples میں placeholder keys استعمال کریں۔ Real API key کبھی public code، screenshots، tickets، یا shared documents میں paste نہ کریں۔

1. API key create کریں

API Keys settings کھولیں، key create کریں، full secret کو صرف ایک بار copy کریں، اور اسے اپنے server-side environment میں store کریں۔

Recommended first scopes:

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

2. Base URL confirm کریں

Production API base URL استعمال کریں:

https://rivya.ai

Localhost URLs صرف local development کے لیے ہیں۔ Public examples میں local secrets استعمال نہیں ہونے چاہئیں۔

3. Models list کریں

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

Generation create کرتے وقت response کے id field کو model value کے طور پر استعمال کریں۔

4. Generation submit کریں

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": "soft studio background پر clean editorial product image"
  }'

Response public task ID return کرتا ہے۔ اسے store کریں تاکہ بعد میں status poll کر سکیں۔

5. Status poll کریں

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

Status values:

queued
processing
succeeded
failed

6. Credits check کریں

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

Testing سے پہلے یا بعد current account balance confirm کرنے کے لیے اسے استعمال کریں۔

7. Optional: Webhooks add کریں

اگر آپ کا server signed HTTPS callbacks receive کر سکتا ہے تو webhook endpoint create کریں:

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"]
  }'

Response سے one-time signing_secret save کریں اور payload پر trust کرنے سے پہلے ہر delivery verify کریں۔

8. Optional: Chat turn send کریں

Chat models کے لیے POST /api/v1/generations کے بجائے Chat API call کریں:

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": "gpt-5-2-chat",
    "message": "نئی product image campaign کے لیے مختصر launch plan لکھیں"
  }'

API-created session continue کرنے کے لیے returned session_id استعمال کریں۔ Image attachments کو Files API file_id values reference کرنی ہوں گی۔

Optional: TypeScript SDK beta استعمال کریں

Server-side TypeScript integrations local SDK beta استعمال کر سکتی ہیں:

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: "soft studio background پر clean editorial product image"
});

اسے adopt کرنے سے پہلے Rivya TypeScript SDK پڑھیں۔ SDK private beta میں server-side Chat streaming support include کرتا ہے۔

Rivya API quickstart