Rivya API

把 Rivya 的多模态模型能力接入你的产品

Rivya API 让产品团队可以用公开、基于账户的方式调用 Rivya 模型。可以先接入异步图片、视频和音频任务，再为支持 Chat 的模型接入带可选 SSE streaming 的 Chat API，计费仍走同一个 Rivya 积分钱包。

查看 API 文档创建 API Key

快速接入形态

模型层

动态目录

计费

共用积分

首发版本

任务 + Chat

访问方式

API Key

请求方法POST

接口路径/api/v1/generations

真实请求必须使用 Rivya API Key，并消耗账户积分。公开示例只使用占位密钥，不允许匿名真实调用模型。

请求示例

curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'

响应示例

{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

首版能力

一个和 Rivya 产品层一致的公开 API

这是 Rivya 自己的产品入口。它使用 Rivya 模型 ID、Rivya 积分、公开任务状态，并和模型目录、文档、调试器保持同源。

图片生成 API

用 prompt 和模型支持的参数提交图片任务，再轮询公开结果。

视频生成 API

用和 Studio 一致的任务、积分和状态边界运行异步视频任务。

音频生成 API

通过同一个账户、余额和历史边界调用已开放 API 的音频模型。

共用积分钱包

API 调用和 Studio 使用同一个 Rivya 余额，遵守预扣积分与失败处理规则。

接入路径

从账户到第一条 API 请求

创建 Key

登录后进入 Settings 的 API Keys 页面，创建带权限范围的 key，并立即保存完整密钥。

选择模型

阅读 API 模型参考，或调用 /api/v1/models 查看模型 ID、参数、Chat capability 和输入 readiness，再决定是否提交。

提交、轮询或订阅

发送带幂等键的生成请求、轮询公开任务接口、用签名 webhooks 接收生成回调，或发送一轮支持可选 SSE streaming 的 Chat API 请求。

版本边界

范围清晰，不暗示未上线能力

公开页可以说明后续方向，但当前文案不能让用户误以为未完成的 API 已经开放。

Chat API

已开放

已支持非 streaming 与 SSE streaming chat turn、API 创建的 session、账户积分结算，以及可选 Files API 图片附件。

Files API

已开放

已支持参考图片、视频和音频上传。当模型页面要求 params.referenceMediaItems 时，先通过 Files API 上传素材。

用户 Webhook

已开放

已开放给希望接收生成成功或失败签名回调的生产集成。

在线调试器

先预览请求，再用你的 API Key 真实提交

所有访客默认进入 mock 模式。生成模型选择器只列出无需上传文件即可测试的非 Chat 模型；Files 面板允许已登录用户用临时 API Key 测试 /api/v1/files。Chat 示例放在 API 文档中。

账户状态

正在检查账户

Active key prefix

请先创建 key

当前积分

登录后查看

Mock 预览真实 Public API没有 active API Key

Mock 模式不会调用模型，也不会消耗积分。

模型

Idempotency key

Client request id

提示词

API Key

只在本次请求中临时粘贴 key。刷新后调试器不会继续保存完整 key。

Files API 上传测试

通过 POST /api/v1/files 上传参考素材，再把返回的 URL 和 duration token 放入支持参考输入模型的 params.referenceMediaItems。

Mock 不上传文件真实请求使用 /api/v1/files

参考模型

文件类型

参考文件

所选模型决定允许的 MIME、大小和时长规则。真实上传需要临时粘贴 API Key，并可能调用真实上传服务。

创建 API Key 阅读 API 文档

请求预览

{
  "model": "z-image",
  "prompt": "干净影棚场景中的编辑风产品照片",
  "params": {
    "aspect_ratio": "1:1"
  }
}

响应

{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}

Files API 响应

{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}

生成参数

{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

任务状态

预计基础积分

状态

queued

API 接入文档

查看鉴权、请求体、响应、幂等、模型参数和错误码说明。

打开文档

API Key 管理

在受保护的 Settings 区域创建、复制一次、吊销和轮换 API Key。

管理 Key

在线调试

先查看 mock 示例；真实调试必须登录、拥有 API Key，并使用账户积分。

预览流程