API-modellen

Gebruik GET /api/v1/models om Rivya-modellen met hun Public API-readiness te tonen.

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

De endpoint is publiek en read-only. Hij retourneert dezelfde publieke modellaag die door de API-docs en online debugger wordt gebruikt, inclusief modellen die nog niet volledig aanroepbaar zijn.

Responseshape

De response gebruikt deze 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": []
    }
  ]
}

Gebruik id als de model-waarde in POST /api/v1/generations voor asynchrone generatiemodellen. Gebruik voor chatmodellen POST /api/v1/chat/completions en controleer chat_capabilities.

Beschikbaarheidsstatussen

De modelreferentie gebruikt deze publieke statussen:

• available: minstens één Public API-generatiepad is beschikbaar
• coming_soon: asynchroon generatiemodel, maar momenteel niet beschikbaar via Public API
• studio_only: model is beschikbaar via Studio of een andere productsurface, niet via Public API v1

Het input-readinessveld is specifieker:

• available_text: promptgebaseerde requests kunnen direct worden getest
• available_url_input: publieke URL- of scalar params kunnen direct worden getest
• partial_requires_files: sommige modi kunnen zonder upload worden aangeroepen; modi met referentiemedia moeten Files API gebruiken
• requires_files_api: het model hangt af van geüploade referentiemedia via /api/v1/files

Gebruik Files API voordat je modi aanroept die geüploade beeld-, video- of audioreferenties vereisen.

Voor chatmodellen documenteert chat_capabilities of Chat API non-streaming responses, streaming responses, web search, afbeelding file_id-attachments, thoughts en reasoning effort ondersteunt.

Beleid voor modelaantallen

De publieke modellenlijst verandert wanneer Rivya modellen toevoegt, verwijdert of afschermt.

Vertrouw in je integratie niet op een hard-coded modelaantal. Lees altijd /api/v1/models of de dynamische Model API-referentie.

Gerelateerde pagina's

• Model API-referentie
• Generatie aanmaken
• Chat API
• Rivya gids voor modelkeuze
• Modelbeschikbaarheid in Rivya