Rivya API モデルを一覧し、モデル ID、カテゴリ、プロンプト上限、参照メディア、準備状態、Files API 依存関係を理解します。

Rivya モデルとその Public API readiness を一覧するには、GET /api/v1/models を使います。

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

このエンドポイントは公開かつ読み取り専用です。API ドキュメントとオンラインデバッガーが使うものと同じ公開モデルレイヤーを返し、まだ完全には呼び出せないモデルも含まれます。

応答形式

応答は次の形式を使います。

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

非同期生成モデルでは、POST /api/v1/generations の model 値として id を使います。チャットモデルでは POST /api/v1/chat/completions を使い、chat_capabilities を確認してください。

可用性の状態

モデルリファレンスでは、次の公開状態を使います。

available: 少なくとも 1 つの Public API 生成パスが利用できます
coming_soon: 非同期生成モデルですが、現在 Public API には公開されていません
studio_only: Studio または別の製品面では利用できますが、Public API v1 では利用できません

入力 readiness フィールドはより具体的です。

available_text: プロンプトベースのリクエストを直接テストできます
available_url_input: 公開 URL またはスカラー params を直接テストできます
partial_requires_files: 一部のモードはアップロードなしで呼び出せますが、参照メディアモードでは Files API を使うべきです
requires_files_api: モデルが /api/v1/files 経由でアップロードされた参照メディアに依存します

アップロード済みの画像、動画、音声参照を必要とするモードを呼び出す前に、Files API を使ってください。

チャットモデルでは、chat_capabilities が Chat API の非ストリーミング応答、ストリーミング応答、web search、画像 file_id 添付、thoughts、reasoning effort の対応状況を示します。

モデル数ポリシー

Rivya がモデルを追加、削除、またはゲートするにつれて、公開モデル一覧は変わります。

統合でモデル数をハードコードしないでください。常に /api/v1/models または動的なモデル API リファレンスを読んでください。

API モデル

応答形式

可用性の状態

モデル数ポリシー

関連ページ

目次