↓
Rivya AI 文档

API 模型列表

查询 Rivya API 模型,理解模型 ID、分类、提示词上限、参考素材、可用状态和 Files API 依赖。

最近审阅于 2026年11月11日

使用 GET /api/v1/models 查询 Rivya 模型及其 Public API readiness 状态。

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

这个端点是公开只读接口。它返回和 API 文档、在线调试器同源的公开模型层,也会包含当前尚未完整可调用的模型。

可用 locale 查询参数请求本地化展示名与参数标签;模型 ID、参数键、选项值和状态不变。不支持的语言回退英文。此列表无需 Key,在线调试器只提供其中一部分模型;列入目录不授予调用资格。

Suno Speech:场景与指定脚本

Suno Speech: prompt 在简单模式(params.customMode="false")中是场景描述,在高级模式("true")中是朗读脚本。tone、variety、vocalGender、backgroundMusic 只用于高级模式;简单模式须省略。不要在 params 中另传 script 或 prompt。

提示词单位与完整图层结果

读取 GET /api/v1/models 时,请将 prompt_length_unit 与 max_prompt_length 一起使用。utf8_bytes 计算原文的 UTF-8 字节,包含空格和换行;utf16_code_units 计算 JavaScript 的 UTF-16 代码单元。上限为 null 不代表文字不限长或可以不填。Gemini TTS 使用字节单位。

已完成的图层拆分结果可在完整的 result.urls 之外提供 result.layers。请保留每层返回的 z_index、URL、尺寸、名称、说明和边界框,索引零是底图。TypeScript SDK 已提供这些字段。参考文件必须按所选模型上传,并传回原始签名元数据;单独声明尺寸或时长不能代替核验。

响应结构

以下仅展示 z-image 的部分字段,不是完整响应;实时响应还包含价格和媒体限制,请以实时值为准。

{
  "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": [
        {
          "key": "aspect_ratio",
          "type": "select",
          "label": "Aspect ratio",
          "required": false,
          "default_value": "1:1",
          "options": [
            { "value": "1:1", "label": "1:1" },
            { "value": "4:3", "label": "4:3" },
            { "value": "3:4", "label": "3:4" },
            { "value": "16:9", "label": "16:9" },
            { "value": "9:16", "label": "9:16" }
          ]
        }
      ],
      "supports_direct_generation": true,
      "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 时,先检查 api_input_status,再把 id 作为 model 值。Chat 模型请调用 POST /api/v1/chat/completions,并检查 chat_capabilities。

读取模型字段

id 用于请求,display_name 只供展示;category 表示类别,runtime 区分异步生成和聊天。supported_modes 是 Rivya 已映射的流程,不代表服务商的全部功能。

max_prompt_length 为 null 不表示提示词不限长或可省略。max_images、max_videos、max_audios 和 reference_media 是配置的媒体限制;null 不表示无限,也不能据此推断必需数量或可组合类型。

params 包含键、类型、标签、默认值和选项。数值参数可带 min、max、step,文字参数可带 max_length。发送选项的 value,不要发送展示标签,并遵守 hide_when_modes。required: false 仍可能有模式条件;完整的输入组合、元数据和校验以模型参考为准。

base_credits、billing_type 和 pricing 描述当前计费配置,最终积分遵循模型的计费与结算规则。notices 是补充说明,应结合模型参考与端点文档阅读。

可用状态

检查 api_status 后再选择新请求:

  • available:可用于公开 API,仍需检查 supports_direct_generation、runtime 和输入要求。

  • temporarily_unavailable:当前不可通过公开 API v1 调用。

  • studio_only:不能通过公开 API v1 调用;实际工作台可用性以当前产品页为准。

  • coming_soon:仅供发现,不能提交生成或聊天请求。

不可调用条目的运行类型、计费、价格、提示词上限、媒体上限及聊天能力为 null,supported_modes 和 params 为空。这不代表解锁模型或免除输入限制。

输入准备状态

api_input_status 是输入方式摘要,不能代替校验:available_text 根据模型使用 prompt、params.dialogue 或聊天 message;available_url_input 使用模型要求的 URL 参数;partial_requires_files 同时有文字或 URL 路径与文件模式,应检查 requires_upload_for_modes;requires_files_api 依赖参考文件,须先上传。

supported_api_inputs 用 text、url、file 概括输入类型,file_kinds 表示可接收的媒体种类,并不允许任意组合。需要参考文件的模式应先使用文件 API。

模型要求签名媒体元数据时,保留原始、与模型绑定的上传响应;单独 URL 或后续 GET /api/v1/files/{fileId} 元数据可能缺少必要 token 和已验证字段。url_input_supported: true 也不免除格式、归属、时长或签名校验。

聊天模型的 chat_capabilities 描述普通响应、SSE、联网搜索、图片 file_id、思考设置支持及推理强度。发送可选字段前检查当前值;服务商支持不代表 Rivya 已启用。

模型数量策略

Rivya 新增、移除或灰度模型时,公开模型列表会变化。

不要在集成里写死模型数量。请读取 /api/v1/models 或动态 模型 API Reference。

实时 OpenAPI 契约分别列出新生成、聊天和上传请求可用的模型 ID。保存的生成及聊天响应仍用字符串 model,可保留历史 ID;不要因旧模型不在当前请求枚举中就拒绝历史响应。

相关页面

即将推出的只读发现项

  • coming_soon:模型只用于发现,不能提交到生成或 Chat API。此类只读项返回 supports_direct_generation: false,runtime、billing 和 pricing 均为 null,supported_modes 与 params 为空。发起请求时请选择 api_status: available 的模型。

模型可用性问题

为什么列表中的模型不在请求枚举中?

公开列表包含暂不可用和 Coming Soon 条目;请求枚举只列对应端点可用的模型,所以生成、聊天和文件上传的枚举不同。选择端点前先检查可用性与输入字段。

notices 为空是否表示没有限制?

不是。notices 只是补充说明,不是完整校验清单。可用模型也可能要求特定文件组合、格式或签名 token,应遵循模型参考及端点文档。