List opp Rivya API-modeller, forstå modell-ID-er, kategorier, promptgrenser, referansemedier, readiness-tilstander og Files API-avhengigheter.

Bruk GET /api/v1/models for å liste Rivya-modeller med deres Public API-readiness.

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

Endepunktet er offentlig og skrivebeskyttet. Det returnerer det samme offentlige modellaget som brukes av API-dokumentasjonen og den nettbaserte debuggeren, inkludert modeller som ikke er fullt kallbare ennå.

Responsform

Responsen bruker denne formen:

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

Bruk id som model-verdien i POST /api/v1/generations for asynkrone genereringsmodeller. For chatmodeller bruker du POST /api/v1/chat/completions og sjekker chat_capabilities.

Tilgjengelighetstilstander

Modellreferansen bruker disse offentlige tilstandene:

available: minst én Public API-genereringsvei er tilgjengelig
coming_soon: asynkron genereringsmodell, men ikke eksponert gjennom Public API akkurat nå
studio_only: modellen er tilgjengelig gjennom Studio eller en annen produktflate, ikke gjennom Public API v1

Feltet for input-readiness er mer spesifikt:

available_text: promptbaserte forespørsler kan testes direkte
available_url_input: offentlig URL eller skalarparams kan testes direkte
partial_requires_files: noen moduser kan kalles uten opplasting; moduser med referansemedier bør bruke Files API
requires_files_api: modellen er avhengig av opplastede referansemedier gjennom /api/v1/files

Bruk Files API før du kaller moduser som krever opplastede bilde-, video- eller lydreferanser.

For chatmodeller dokumenterer chat_capabilities om Chat API støtter ikke-streamende svar, streamende svar, nettsøk, bildevedlegg med file_id, thoughts og reasoning effort.

Modellantall-policy

Den offentlige modellisten endres etter hvert som Rivya legger til, fjerner eller begrenser modeller.

Ikke stol på et hardkodet modellantall i integrasjonen din. Les alltid /api/v1/models eller den dynamiske modell-API-referansen.

API-modeller

Responsform

Tilgjengelighetstilstander

Modellantall-policy

Relaterte sider

Innholdsfortegnelse