使用 Rivya API v1 从你的产品调用 Rivya 生成模型和 Chat 模型，通过 API Key 鉴权、账户积分和可选 SSE streaming 集成。

当部署已启用 Public API，且你的账号具备访问权限时，Rivya API v1 就是从自有产品调用 Rivya 已支持模型能力的开发者契约。

当前已实现的契约涵盖异步图片、视频和音频生成，以及支持非流式或 SSE 流式响应的 Chat API 对话。它使用 Rivya 模型 ID 和账户积分；生成任务使用公开任务 ID，Chat API 则使用服务端会话。文档列出某条路由，并不代表每个环境、账号或目录模型都能调用它；接入前请确认实时访问权限和模型就绪状态。

API 适合做什么

当你需要下面这些能力时，可以使用 API：

从你自己的应用提交图片、视频或音频生成任务
发送非 streaming 或 streaming Chat turn，并继续 API 创建的对话 session
让计费继续走同一个 Rivya 账户积分钱包
通过公开任务 ID 轮询任务状态
用幂等重试降低生产请求风险
让 Studio 和 API 使用保持在同一个账户边界内

API 是 Rivya 的产品层。公共响应只使用 Rivya 名称和公开字段。

当前版本范围

已实现的 v1 端点包括：

GET /api/v1/models
POST /api/v1/generations
POST /api/v1/files
GET /api/v1/files/{fileId}
POST /api/v1/chat/completions
GET /api/v1/chat/sessions
GET /api/v1/chat/sessions/{sessionId}
GET /api/v1/generations/{taskId}
GET /api/v1/credits
GET /api/v1/webhooks
POST /api/v1/webhooks
GET /api/v1/webhook-events
GET /api/v1/openapi.json

当前契约包含用于异步生成结果的签名 webhook、Chat API，以及支持服务端流式传输的 TypeScript SDK beta。调用 webhook 相关端点前，部署必须已启用 webhook 功能和 Public API 访问。

鉴权

生成、状态和积分端点需要：

Authorization: Bearer rvya_sk_...

在 API Keys 设置创建和轮换 key。生产使用前，请先阅读 API 鉴权。

计费模型

API 调用使用和 Studio 相同的 Rivya 账户积分。

生成任务开始时会预留或消耗积分。Chat turn 会先预留积分，并在 assistant message 保存时根据 token usage 做最终结算。如果生成任务或 Chat turn 按 Rivya 现有失败规则失败，会沿用相同的退款处理。

账户钱包模型可以继续阅读 API 积分和 Rivya 积分与账单。

首次接入路径

在 Settings 创建 API Key。
调用 API 模型列表选择公开模型 ID。
阅读模型 API Reference 查看模型参数。
如果模型需要参考素材，先使用 Files API 上传。
按创建生成任务提交任务。
通过生成任务状态轮询，直至任务成功或失败。如果部署和账号已启用 webhook，也可以改为订阅 API Webhooks，接收签名完成事件。
对 Chat 模型，请使用 Chat API，不要调用生成任务端点。Chat 图片附件必须引用 Files API 返回的 file_id。

Rivya API 总览

API 适合做什么

当前版本范围

鉴权

计费模型

首次接入路径

相关页面

目录