Rivya API

Rivya کی ملٹی موڈل model layer پر build کریں

Rivya API product teams کو اپنی apps سے Rivya models کال کرنے کا public، account-based طریقہ دیتی ہے۔ asynchronous image، video اور audio jobs سے شروع کریں، chat-capable model کے لیے optional SSE streaming کے ساتھ Chat API turns شامل کریں، اور billing اسی Rivya credit wallet کے اندر رکھیں۔
API docs پڑھیںAPI key بنائیں

Quickstart shape

Model layer

Dynamic catalog

Billing

Shared credits

First version

Jobs + Chat

Access

API keys

MethodPOST
Endpoint/api/v1/generations

حقیقی request کے لیے Rivya API key اور account میں دستیاب credits ضروری ہیں۔ Public examples placeholder secrets استعمال کرتے ہیں اور models کو anonymously کال نہیں کرتے۔

Request
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"
  }'
Response
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

پہلے کیا ship ہوتا ہے

ایک public API layer جو Rivya product کے ساتھ aligned رہتی ہے

یہ API ایک Rivya product surface کے طور پر design کی گئی ہے۔ یہ Rivya model IDs، Rivya credits، public task states اور ایسے docs استعمال کرتی ہے جو model catalog سے connected رہتے ہیں۔

Image generation API

prompt اور supported model parameters کے ساتھ image jobs submit کریں، پھر public results کے لیے poll کریں۔

Video generation API

Studio میں استعمال ہونے والے اسی task اور credit controls کے ساتھ asynchronous video jobs چلائیں۔

Audio generation API

اسی account، balance اور history boundary کے ذریعے API-accessible audio models استعمال کریں۔

Shared credit wallet

API calls اور Studio usage ایک ہی Rivya balance سے credits لیتے ہیں، reserved credits اور failure handling کے ساتھ۔

Start path

Account سے پہلی API request تک

01

Key بنائیں

Sign in کریں، Settings میں API Keys کھولیں، scoped key بنائیں، اور full secret فوراً محفوظ کریں۔

02

Model منتخب کریں

submit کرنے سے پہلے API model reference پڑھیں یا /api/v1/models کال کرکے model IDs، parameters، chat capabilities اور input readiness دیکھیں۔

03

Submit، poll یا subscribe کریں

idempotent generation request بھیجیں، public task endpoint کو poll کریں، generation callbacks کے لیے signed webhooks استعمال کریں، یا optional SSE streaming کے ساتھ Chat API turn بھیجیں۔

Version boundary

واضح scope، hidden promises نہیں

Landing page future surfaces کا ذکر کر سکتی ہے، مگر current product copy کو یہ تاثر نہیں دینا چاہیے کہ unfinished APIs پہلے ہی live ہیں۔

Chat API

دستیاب

API-created sessions، account credits اور optional Files API image attachments کے ساتھ non-streaming اور SSE streaming turns کے لیے دستیاب ہے۔

Files API

دستیاب

Reference image، video اور audio uploads کے لیے دستیاب ہے۔ جب model page params.referenceMediaItems مانگے تو generation سے پہلے اسے استعمال کریں۔

User webhooks

دستیاب

production integrations کے لیے دستیاب ہے جو succeeded یا failed generation tasks کے signed callbacks چاہتے ہیں۔

Online debugger

پہلے request preview کریں، پھر اپنی API key کے ساتھ run کریں

Debugger ہر visitor کے لیے mock mode سے شروع ہوتا ہے۔ generation selector ایسے non-chat models دکھاتا ہے جنہیں files upload کیے بغیر test کیا جا سکتا ہے، جبکہ Files panel signed-in users کو temporary API key کے ساتھ /api/v1/files test کرنے دیتا ہے۔ Chat examples API docs میں ہیں۔

Account state

Account check ہو رہا ہے

Active key prefix

پہلے key بنائیں

Current credits

Check کرنے کے لیے sign in کریں

Mock previewLive Public APIActive API key نہیں ہے

Mock mode کبھی model call نہیں کرتا اور credits consume نہیں کرتا۔

Key صرف اس request کے لیے paste کریں۔ Refresh کے بعد debugger اسے store نہیں کرتا۔

Files API upload test

POST /api/v1/files کے ذریعے reference media upload کریں، پھر returned URL اور duration token کو ایسے model کے params.referenceMediaItems میں copy کریں جو reference inputs support کرتا ہے۔

Mock کبھی upload نہیں کرتاLive /api/v1/files استعمال کرتا ہے

Selected model allowed MIME types، size اور duration rules control کرتا ہے۔ Live uploads کے لیے آپ کی temporary API key ضروری ہے اور real upload service call ہو سکتی ہے۔

API key بنائیںAPI docs پڑھیں
Request preview
{
  "model": "z-image",
  "prompt": "صاف studio set پر editorial product photo",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Response
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Files API response
{
  "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
}
Generation params
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Task state

Estimated base credits

1

Status

queued

API documentation

authentication، request bodies، responses، idempotency، model parameters اور error codes پڑھیں۔

Docs کھولیں

API key management

Protected Settings area سے API keys create، copy once، revoke اور rotate کریں۔

Keys manage کریں

Online debugging

پہلے mock examples استعمال کریں؛ real debugging کے لیے login، API key اور account credits ضروری ہیں۔

Flow preview کریں