Listaa Rivya API -mallit ja ymmärrä mallitunnukset, kategoriat, promptirajat, referenssimedia, valmiustilat ja Files API -riippuvuudet.

Käytä GET /api/v1/models -endpointtia Rivya-mallien listaamiseen niiden Public API -valmiuden kanssa.

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

Endpoint on julkinen ja vain lukuun tarkoitettu. Se palauttaa saman julkisen mallikerroksen, jota API-dokumentaatio ja verkkodebuggeri käyttävät, mukaan lukien mallit, joita ei vielä voi täysin kutsua.

Vastauksen muoto

Vastaus käyttää tätä muotoa:

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

Käytä id-arvoa model-arvona endpointissa POST /api/v1/generations asynkronisille generointimalleille. Chat-malleissa käytä POST /api/v1/chat/completions -endpointtia ja tarkista chat_capabilities.

Saatavuustilat

Malliviite käyttää näitä julkisia tiloja:

available: vähintään yksi Public API -generointipolku on saatavilla
coming_soon: asynkroninen generointimalli, mutta ei tällä hetkellä esillä Public API:n kautta
studio_only: malli on saatavilla Studiossa tai toisella tuotepinnalla, ei Public API v1:n kautta

Syötevalmiuden kenttä on tarkempi:

available_text: promptipohjaisia pyyntöjä voi testata suoraan
available_url_input: julkista URL-osoitetta tai skalaarisia params-arvoja voi testata suoraan
partial_requires_files: joitakin tiloja voi kutsua ilman latausta; referenssimediatilojen tulee käyttää Files API:a
requires_files_api: malli riippuu /api/v1/files-endpointin kautta ladatusta referenssimediasta

Käytä Files API:a ennen sellaisten tilojen kutsumista, jotka vaativat ladattuja kuva-, video- tai audioreferenssejä.

Chat-malleissa chat_capabilities kertoo, tukeeko Chat API ei-streamaavia vastauksia, streamaavia vastauksia, verkkohakua, kuvan file_id-liitteitä, thoughts-tilaa ja päättelypanosta.

Mallimäärän käytäntö

Julkinen malliluettelo muuttuu, kun Rivya lisää, poistaa tai rajoittaa malleja.

Älä nojaa integraatiossasi kovakoodattuun mallimäärään. Lue aina /api/v1/models tai dynaaminen mallien API-viite.

API-mallit

Vastauksen muoto

Saatavuustilat

Mallimäärän käytäntö

Liittyvät sivut

Sisällysluettelo