API-modeller

Använd GET /api/v1/models för att lista Rivya-modeller med deras Public API-readiness.

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

Endpointen är offentlig och skrivskyddad. Den returnerar samma offentliga modellager som används av API-dokumentationen och online-debuggern, inklusive modeller som ännu inte är fullt anropsbara.

Svarsform

Svaret använder denna form:

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

Använd id som värde för model i POST /api/v1/generations för asynkrona genereringsmodeller. För chattmodeller använder du POST /api/v1/chat/completions och kontrollerar chat_capabilities.

Tillgänglighetslägen

Modellreferensen använder dessa offentliga lägen:

• available: minst en Public API-genereringsväg är tillgänglig
• coming_soon: asynkron genereringsmodell, men den exponeras inte för Public API just nu
• studio_only: modellen är tillgänglig via Studio eller en annan produktyta, inte via Public API v1

Fältet för indata-readiness är mer specifikt:

• available_text: promptbaserade begäranden kan testas direkt
• available_url_input: offentliga URL:er eller skalära params kan testas direkt
• partial_requires_files: vissa lägen kan anropas utan uppladdning; lägen med referensmedia bör använda Files API
• requires_files_api: modellen beror på uppladdad referensmedia via /api/v1/files

Använd Files API innan du anropar lägen som kräver uppladdade bild-, video- eller ljudreferenser.

För chattmodeller dokumenterar chat_capabilities om Chat API stöder icke-streamande svar, streamande svar, webbsökning, bildbilagor via file_id, thoughts och reasoning effort.

Policy för modellantal

Den offentliga modellistan ändras när Rivya lägger till, tar bort eller spärrar modeller.

Förlita dig inte på ett hårdkodat modellantal i din integration. Läs alltid /api/v1/models eller den dynamiska modellreferensen för API.

Relaterade sidor

• Modellreferens för API
• Skapa generation
• Chat API
• Rivyas guide till modellval
• Modelltillgänglighet i Rivya