Rivya API 总览

Rivya API v1 是面向开发者的接入口，用来从你自己的产品调用 Rivya 模型能力。

当前公开 API 支持异步图片、视频、音频生成，也支持非 streaming 或 SSE streaming 的 Chat API。生成任务使用 Rivya 模型 ID、账户积分、公开任务 ID 和稳定状态值；Chat API 使用服务端 session 保存上下文。

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 和带服务端 streaming 支持的 TypeScript SDK beta。

鉴权

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

Authorization: Bearer rvya_sk_...

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

计费模型

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

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

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

首次接入路径

1. 在 Settings 创建 API Key。
2. 调用 API 模型列表 选择公开模型 ID。
3. 阅读 模型 API Reference 查看模型参数。
4. 如果模型需要参考素材，先使用 Files API 上传。
5. 按 创建生成任务 提交任务。
6. 通过 生成任务状态 轮询到成功或失败，或订阅 API Webhooks 接收签名完成事件。
7. 对 Chat 模型，请使用 Chat API，不要调用生成任务端点。Chat 图片附件必须引用 Files API 返回的 file_id。

相关页面

• API 快速开始
• API 鉴权
• Rivya TypeScript SDK
• 模型 API Reference
• Chat API
• API Webhooks
• API 错误码与限制