Rivya API Overview

Rivya API v1 হলো আপনার নিজের product থেকে Rivya model capabilities call করার developer entry point।

public API asynchronous image, video এবং audio generation support করে, plus non-streaming বা SSE streaming responses সহ Chat API turns। এটি generation-এর জন্য Rivya model IDs, Rivya account credits, public task IDs, এবং Chat API-এর জন্য server-side chat sessions ব্যবহার করে।

What The API Is For

আপনি চাইলে API ব্যবহার করুন:

• আপনার নিজের app থেকে image, video বা audio generation jobs submit করতে
• non-streaming বা streaming chat turns পাঠাতে এবং API-created chat sessions continue করতে
• billing একই Rivya account credit wallet-এর ভিতরে রাখতে
• public task ID দিয়ে task status poll করতে
• safer production requests-এর জন্য idempotent retries ব্যবহার করতে
• Studio এবং API usage একই account boundary-র মধ্যে রাখতে

API একটি Rivya product layer। Public responses শুধু Rivya names এবং public fields ব্যবহার করে।

Current Version Scope

Current v1 endpoints:

• GET /api/v1/models
• POST /api/v1/generations
• POST /api/v1/files
• GET /api/v1/files/{fileId}
• POST /api/v1/chat/completions
• GET /api/v1/chat/sessions
• GET /api/v1/chat/sessions/{sessionId}
• GET /api/v1/generations/{taskId}
• GET /api/v1/credits
• GET /api/v1/webhooks
• POST /api/v1/webhooks
• GET /api/v1/webhook-events
• GET /api/v1/openapi.json

current version asynchronous generation results-এর জন্য signed webhooks, Chat API, এবং server-side streaming support সহ TypeScript SDK beta অন্তর্ভুক্ত করে।

Authentication

Generation, status এবং credit endpoints require:

Authorization: Bearer rvya_sk_...

API Keys settings থেকে keys create এবং rotate করুন। production-এ key ব্যবহার করার আগে API Authentication পড়ুন।

Billing Model

API calls Studio-র মতো একই Rivya account credits ব্যবহার করে।

task start হলে generation jobs credits reserve বা consume করে। Chat turns model call-এর আগে credits reserve করে এবং assistant message save হলে token usage থেকে final credits settle করে। existing Rivya failure rules অনুযায়ী generation বা chat turn fail করলে একই refund handling apply হয়।

user-facing wallet model-এর জন্য API Credits এবং Credits & Billing in Rivya পড়ুন।

First Integration Path

1. Settings-এ API key create করুন।
2. public model ID choose করতে List API Models call করুন।
3. model-এর parameters-এর জন্য Model API Reference পড়ুন।
4. model reference media চাইলে Files API দিয়ে upload করুন।
5. Create Generation দিয়ে job submit করুন।
6. task succeeds বা fails হওয়া পর্যন্ত Generation Status poll করুন, অথবা signed completion events-এর জন্য API Webhooks subscribe করুন।
7. chat models-এর জন্য generation endpoint-এর বদলে Chat API ব্যবহার করুন। Chat image attachments অবশ্যই Files API file_id values reference করবে।

Related Pages

• API Quickstart
• API Authentication
• Rivya TypeScript SDK
• Model API Reference
• Chat API
• API Webhooks
• API Errors and Limits