Rivya AI ডকস

API Models

Rivya API models list করুন, model IDs, categories, prompt limits, reference media, readiness states এবং Files API dependencies বুঝুন।

শেষ review 2026/05/11

Rivya models এবং তাদের Public API readiness list করতে GET /api/v1/models ব্যবহার করুন।

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

endpoint-টি public এবং read-only। এটি API docs এবং online debugger যে একই public model layer ব্যবহার করে তা return করে, fully callable নয় এমন models-ও অন্তর্ভুক্ত থাকতে পারে।

Response Shape

response এই shape ব্যবহার করে:

{
  "object": "list",
  "data": [
    {
      "id": "z-image",
      "display_name": "Z-Image",
      "category": "image",
      "runtime": "async_task",
      "base_credits": 1,
      "billing_type": "FIXED",
      "supported_modes": ["text-to-image"],
      "max_prompt_length": 1000,
      "reference_media": null,
      "params": [],
      "api_status": "available",
      "api_input_status": "available_text",
      "supported_api_inputs": ["text"],
      "requires_files_api": false,
      "requires_upload_for_modes": [],
      "url_input_supported": false,
      "file_kinds": [],
      "chat_capabilities": null,
      "notices": []
    }
  ]
}

asynchronous generation models-এর জন্য POST /api/v1/generations-এ id-কে model value হিসেবে ব্যবহার করুন। chat models-এর জন্য POST /api/v1/chat/completions ব্যবহার করুন এবং chat_capabilities check করুন।

Availability States

model reference এই public states ব্যবহার করে:

  • available: কমপক্ষে একটি Public API generation path available
  • coming_soon: async generation model, কিন্তু currently Public API-তে exposed নয়
  • studio_only: model Studio বা অন্য product surface-এ available, Public API v1-এ নয়

input readiness field আরও specific:

  • available_text: prompt-based requests সরাসরি test করা যায়
  • available_url_input: public URL বা scalar params সরাসরি test করা যায়
  • partial_requires_files: কিছু modes upload ছাড়া call করা যায়; reference-media modes-এ Files API ব্যবহার করা উচিত
  • requires_files_api: model /api/v1/files দিয়ে uploaded reference media-এর ওপর depend করে

uploaded image, video বা audio references দরকার এমন modes call করার আগে Files API ব্যবহার করুন।

chat models-এর জন্য chat_capabilities document করে Chat API non-streaming responses, streaming responses, web search, image file_id attachments, thoughts এবং reasoning effort support করে কি না।

Model Count Policy

Rivya models add, remove বা gate করলে public model list বদলায়।

আপনার integration-এ hard-coded model count-এর ওপর নির্ভর করবেন না। সবসময় /api/v1/models বা dynamic Model API Reference পড়ুন।

Table of Contents