Rivya AI दस्तावेज़

API Models

Rivya API models list करें, model IDs, categories, prompt limits, reference media, readiness states और Files API dependencies समझें.

अंतिम समीक्षा 2026/05/11 को

Public API readiness के साथ Rivya models list करने के लिए GET /api/v1/models इस्तेमाल करें।

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

यह endpoint public और read-only है। यह वही public model layer return करता है जिसे API docs और online debugger इस्तेमाल करते हैं, जिसमें वे models भी शामिल हैं जो अभी पूरी तरह callable नहीं हैं।

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 के लिए id को model value के रूप में POST /api/v1/generations में इस्तेमाल करें। 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 है, लेकिन अभी 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 पर निर्भर करता है

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

Public model list बदलती रहती है क्योंकि Rivya models जोड़ता, हटाता या gate करता है।

अपनी integration में hard-coded model count पर निर्भर न रहें। हमेशा /api/v1/models या dynamic Model API Reference पढ़ें।

संबंधित पेज

विषय-सूची