API key create করুন, model choose করুন, asynchronous generation job submit করুন, এবং optional SSE streaming সহ Chat API turn পাঠান।

এই quickstart account setup থেকে একটি Rivya API generation job, plus প্রথম Chat API turn পর্যন্ত shortest safe path দেখায়।

docs এবং examples-এ placeholder keys ব্যবহার করুন। real API key কখনো public code, screenshots, tickets বা shared documents-এ paste করবেন না।

1. Create An API Key

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. Confirm Your Base URL

production API base URL ব্যবহার করুন:

https://rivya.ai

Localhost URLs শুধু local development-এর জন্য। Public examples local secrets ব্যবহার করা উচিত নয়।

3. List Models

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

generation create করার সময় response-এর id field-টি model value হিসেবে ব্যবহার করুন।

4. Submit A Generation

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

response public task ID return করে। পরে status poll করতে এটি store করুন।

5. Poll Status

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

Status values:

queued
processing
succeeded
failed

6. Check Credits

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

testing-এর আগে বা পরে current account balance confirm করতে এটি ব্যবহার করুন।

7. Optional: Add Webhooks

আপনার 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 করার আগে every delivery verify করুন।

8. Optional: Send A Chat Turn

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": "Write a concise launch plan for a new product image campaign"
  }'

API-created session continue করতে returned session_id ব্যবহার করুন। Image attachments অবশ্যই Files API file_id values reference করবে।

Optional: Use The 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: "A clean editorial product image on a soft studio background"
});

adopt করার আগে Rivya TypeScript SDK পড়ুন। SDK private beta-তে server-side Chat streaming support অন্তর্ভুক্ত আছে।

Rivya API Quickstart