Rivya API হলো আপনার নিজের product, script বা workflow থেকে Rivya model capabilities ব্যবহার করার developer path।
এটি Rivya Studio থেকে আলাদা কোনো product নয়। এটি একই account boundary, একই credit wallet এবং Rivya জুড়ে ব্যবহারকারীরা যে public model layer দেখেন সেটিই ব্যবহার করে। পার্থক্য হলো কাজ কীভাবে শুরু হয়: Studio-তে click করার বদলে আপনার application API key দিয়ে request পাঠায়।
endpoint details দরকার হলে Rivya API Overview এবং Rivya API Quickstart দিয়ে শুরু করুন। এই article product-level ব্যাখ্যা: API কীসের জন্য, কোথায় fit করে এবং কখন এটি first path হওয়া উচিত নয়।
সংক্ষিপ্ত সংস্করণ
Rivya API v1 signed-in account-কে API keys তৈরি করতে এবং web interface-এর বাইরে থেকে Rivya model capabilities call করতে দেয়।
বর্তমান API surface-এ আছে:
- API model list দিয়ে model discovery
- asynchronous image, video এবং audio generation jobs
- reference media দরকার এমন model-এর জন্য Files API uploads
- public task IDs দিয়ে generation status polling
- account credit checks
- Chat API turns, optional SSE streaming সহ
- generation completion-এর জন্য signed webhooks
- client wrapper চাই এমন team-এর জন্য TypeScript SDK beta
public developer hub হলো Developers। guided overview, API key settings-এর link এবং safe debugger flow চাইলে এটি সেরা entry।
Rivya-র API কেন আছে
মানুষ যখন এখনও model বেছে নিচ্ছে, prompt shape করছে, output review করছে এবং পরের ধাপ ঠিক করছে, তখন Studio দরকারি।
সেই সিদ্ধান্ত repeatable product বা operational workflow হয়ে গেলে API দরকারি।
সাধারণ উদাহরণ:
- user brief submit করার পরে product image variations generate করতে চায়
- marketing workflow structured campaign inputs থেকে visual drafts তৈরি করতে চায়
- internal tool browser খুলতে না বলেই video বা audio jobs submit করতে চায়
- support বা content system নিজের interface-এর ভিতরে একটি chat model turn চায়
- backend service generation jobs শেষ হলে signed callbacks চায়
এই ক্ষেত্রে Rivya API billing, model selection এবং task status-এর জন্য আলাদা stack চাপিয়ে না দিয়ে কাজকে একই Rivya account-এর সঙ্গে connected রাখে।
API কী replace করে না
API সরাসরি Rivya ব্যবহারের সব কারণ replace করে না।
Studio বা public work surfaces ব্যবহার করুন যখন:
- prompt এখনও human exploration চায়
- model choice stable নয়
- creator-কে output visually compare করতে হয়
- project saved history এবং manual review-এর ওপর নির্ভর করে
- team এখনও কোন input এবং output format repeatable হবে তা ঠিক করেনি
workflow automate করার মতো পরিষ্কার হলে API ব্যবহার করুন।
এই boundary গুরুত্বপূর্ণ। অস্পষ্ট creative question সাধারণত প্রথমে Studio-তেই থাকে। predictable inputs সহ known product flow API-তে যেতে পারে।
প্রধান building blocks
API-কে ছয়টি connected piece হিসেবে ভাবুন।
| Building block | কী handle করে | এরপর কোথায় পড়বেন |
|---|---|---|
| API keys | আপনার account থেকে server-to-server access | API Authentication |
| Models | Public model IDs এবং readiness information | API Models |
| Generations | Async image, video এবং audio jobs | Create Generation |
| Files | Reference image, video বা audio uploads | Files API |
| Chat | Non-streaming বা streaming chat turns | Chat API |
| Webhooks | generation jobs-এর জন্য signed completion events | API Webhooks |
request এবং response shape-এর source হলো API docs। এই article আপনাকে আগে কোন piece দরকার তা ঠিক করতে সাহায্য করবে।
Credits কীভাবে কাজ করে
API usage Studio-এর মতো একই Rivya account credit wallet থেকে খরচ হয়।
এর মানে API কোনো anonymous model proxy নয়। একটি request একটি Rivya account-এর, সেই account তৈরি করা API key ব্যবহার করে এবং API Credits-এ বর্ণিত একই product-level credit boundary অনুসরণ করে।
team-এর জন্য এটি দরকারি, কারণ Studio experiments এবং API usage একই operational model-এ থাকে। আপনি manually একটি model test করতে পারেন, তারপর repeatable অংশ integration-এ নিতে পারেন, দ্বিতীয় billing layer তৈরি না করেই।
Files কীভাবে fit করে
কিছু model শুধু text দিয়েই run করতে পারে। অন্যগুলির reference image, video বা audio file দরকার।
API integrations-এর জন্য সেই references Files API দিয়ে যাওয়া উচিত। upload একটি managed file record তৈরি করে, যা supported model parameters-এ pass করা যায়।
practical rule সহজ:
- model text-only input নিলে generation endpoint দিয়ে শুরু করুন
- model reference media চাইলে আগে file upload করুন
- model chat model হলে এবং image attachments চাইলে Chat API ও file IDs ব্যবহার করুন
browser-only upload flows বা saved Studio sessions-এর ওপর integration design করবেন না। API-এর নিজস্ব public file boundary আছে কারণ সেটি প্রয়োজনীয়।
Webhooks কোথায় সাহায্য করে
Polling সবচেয়ে সহজ first integration path। generation job submit করুন, public task ID save করুন এবং success বা failure হওয়া পর্যন্ত poll করুন।
integration বেশি production-like হলে webhooks দরকারি হয়:
- প্রতিটি job-এর জন্য worker poll করতে চান না
- generation শেষ হলে app-কে record update করতে হবে
- safely retry করা যায় এমন signed event চান
- failed jobs স্পষ্ট recovery path-এ যেতে হবে
signed event contract-এর জন্য API Webhooks ব্যবহার করুন। webhook receiver narrow রাখুন: signatures verify করুন, duplicate events handle করুন এবং secret values logs-এ রাখবেন না।
ভালো first API project
সেরা first API project সাধারণত ছোট এবং concrete হয়।
উদাহরণ:
- settings-এ API key তৈরি করুন
- model list call করুন
- একটি available model বেছে নিন
- idempotency key সহ একটি generation job submit করুন
- status endpoint poll করুন
- আগে ও পরে credits check করুন
- তারপরই Files API, Chat API বা Webhooks যোগ করুন
এই path প্রথম test-এ সব API feature মিশিয়ে না দিয়ে working integration দেয়।
কখন API ভুল starting point
API সম্ভবত সঠিক first step নয় যখন:
- team এখনও model family বেছে নেয়নি
- desired output প্রতি run-এ বদলাচ্ছে
- prompt manual taste এবং review-এর ওপর নির্ভর করে
- integration credit usage লুকিয়ে দেবে সেই মানুষদের কাছ থেকে যাদের এটি বুঝতে হবে
- product automation-এর আগে public demo চায়
এই ক্ষেত্রে Image, Video, Audio, Chat বা AI Models থেকে শুরু করুন। path repeatable হলে stable অংশ API-তে নিন।
এরপর কোথায় যাবেন
- public API hub এবং debugger-এর জন্য Developers খুলুন।
- প্রথম safe request করতে Rivya API Quickstart পড়ুন।
- server-এ key রাখার আগে API Authentication পড়ুন।
- model IDs বেছে নেওয়ার আগে API Models পড়ুন।
- product boundary এখনও পরিষ্কার না হলে When to Use Rivya API Instead of Studio পড়ুন।
- full image, video, audio বা chat integration plan করলে How to Build a Multimodal AI Workflow with Rivya API পড়ুন।
