Rivya AI-dokumentation

API-modeller

List Rivya API-modeller, forstå model-ID'er, kategorier, promptgrænser, referencemedier, readiness-tilstande og Files API-afhængigheder.

Sidst gennemgået den 2026/05/11

Brug GET /api/v1/models til at liste Rivya-modeller med deres Public API-readiness.

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

Endpointet er offentligt og read-only. Det returnerer det samme offentlige modellag, som bruges af API-docs og online-debuggeren, inklusive modeller der endnu ikke er fuldt kaldbar.

Svarformat

Svaret bruger dette format:

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

Brug id som model-værdi i POST /api/v1/generations for asynkrone genereringsmodeller. For chatmodeller skal du bruge POST /api/v1/chat/completions og kontrollere chat_capabilities.

Tilgængelighedstilstande

Modelreferencen bruger disse offentlige tilstande:

  • available: mindst én Public API-genereringsvej er tilgængelig
  • coming_soon: asynkron genereringsmodel, men den er ikke aktuelt eksponeret gennem Public API
  • studio_only: modellen er tilgængelig gennem Studio eller en anden produktflade, ikke gennem Public API v1

Feltet for input-readiness er mere specifikt:

  • available_text: promptbaserede anmodninger kan testes direkte
  • available_url_input: offentlig URL eller scalar params kan testes direkte
  • partial_requires_files: nogle modes kan kaldes uden upload; modes med referencemedier bør bruge Files API
  • requires_files_api: modellen afhænger af uploadede referencemedier gennem /api/v1/files

Brug Files API, før du kalder modes, der kræver uploadede billed-, video- eller audioreferencer.

For chatmodeller dokumenterer chat_capabilities, om Chat API understøtter ikke-streaming-svar, streaming-svar, web search, billedvedhæftninger med file_id, thoughts og reasoning effort.

Politik for modelantal

Den offentlige modelliste ændrer sig, når Rivya tilføjer, fjerner eller gatekeeper modeller.

Stol ikke på et hard-coded modelantal i din integration. Læs altid /api/v1/models eller den dynamiske Model API Reference.

Relaterede sider

Indholdsfortegnelse