API modellek

Használd a GET /api/v1/models endpointot a Rivya modellek és Public API készenléti állapotuk listázásához.

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

Az endpoint nyilvános és csak olvasható. Ugyanazt a nyilvános modellréteget adja vissza, amelyet az API dokumentáció és az online debugger használ, beleértve azokat a modelleket is, amelyek még nem teljesen hívhatók.

Válasz alakja

A válasz ezt az alakot használja:

{
  "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": []
    }
  ]
}

Aszinkron generálási modelleknél az id értékét használd model értékként a POST /api/v1/generations hívásban. Chatmodelleknél használd a POST /api/v1/chat/completions endpointot, és ellenőrizd a chat_capabilities mezőt.

Elérhetőségi állapotok

A modellreferencia ezeket a nyilvános állapotokat használja:

• available: legalább egy Public API generálási útvonal elérhető

• temporarily_unavailable: a modell átmenetileg nem érhető el, és jelenleg nem hívható meg a Public API v1-en keresztül

• studio_only: a modell Studión vagy a termék egy másik területén elérhető, de Public API v1-en nem

A bemeneti készenléti mező konkrétabb:

• available_text: promptalapú kérések közvetlenül tesztelhetők

• available_url_input: nyilvános URL vagy skalár paraméterek közvetlenül tesztelhetők

• partial_requires_files: egyes módok feltöltés nélkül hívhatók; a referenciamédiás módokhoz Files API-t kell használni

• requires_files_api: a modell a /api/v1/files útvonalon feltöltött referenciamédiától függ

A feltöltött kép-, videó- vagy hangreferenciákat igénylő módok hívása előtt használd a Files API oldalt.

Chatmodelleknél a chat_capabilities dokumentálja, hogy a Chat API támogatja-e a nem streamelt válaszokat, streamelt válaszokat, webes keresést, kép file_id csatolmányokat, thoughts funkciót és reasoning effort beállítást.

Modell-darabszám irányelv

A nyilvános modelllista változik, ahogy a Rivya modelleket ad hozzá, távolít el vagy korlátoz.

Ne támaszkodj keményen kódolt modell-darabszámra az integrációdban. Mindig olvasd a /api/v1/models endpointot vagy a dinamikus Modell API referenciát.

Kapcsolódó oldalak

• Modell API referencia

• Generálás létrehozása

• Chat API

• Rivya modellválasztási útmutató

• Modellelérhetőség a Rivyában

Csak olvasható Hamarosan bejegyzések

• coming_soon: a modell csak felfedezésre látható, és nem küldhető a generálási vagy Chat API-nak. supports_direct_generation: false, null runtime, számlázás és ár, valamint üres supported_modes és params értékeket ad. Kérésekhez válassz api_status: available modellt.