Rivya API 總覽

Rivya API v1 是從你自己的產品呼叫 Rivya 模型能力的開發者入口。

公開 API 支援非同步圖片、影片和音訊生成，也支援具備非串流或 SSE 串流回應的 Chat API 回合。它使用 Rivya 模型 ID、Rivya 帳號點數、生成用的公開 task IDs，以及 Chat API 的伺服器端聊天工作階段。

API 適合做什麼

當你想要以下能力時，請使用 API：

• 從你自己的 app 提交圖片、影片或音訊生成 job
• 送出非串流或串流聊天回合，並繼續 API 建立的聊天工作階段
• 將帳單保留在同一個 Rivya 帳號點數錢包中
• 依公開 task ID 輪詢 task status
• 對 production requests 使用冪等重試，提高安全性
• 讓 Studio 和 API usage 保持在同一個帳號邊界內

API 是 Rivya 的產品層。公開回應只使用 Rivya names 和公開欄位。

目前版本範圍

目前 v1 endpoints：

• 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

目前版本包含用於非同步生成結果的已簽名 webhooks、Chat API，以及具備伺服器端串流支援的 TypeScript SDK beta。

驗證

生成、狀態和點數 endpoints 需要：

Authorization: Bearer rvya_sk_...

請從 API Keys 設定 建立和輪換 keys。在 production 中使用 key 前，請閱讀 API 驗證。

計費模型

API 呼叫使用與 Studio 相同的 Rivya 帳號點數。

生成 job 會在任務開始時預留或消耗點數。Chat 回合會在模型呼叫前預留點數，並在 assistant 訊息儲存時依 token 使用量結算最終點數。如果生成或聊天回合依照既有 Rivya 失敗規則失敗，會套用相同的退款處理。

請閱讀 API 點數 和 Rivya 點數與帳單，了解使用者可見的錢包模型。

首次整合路徑

1. 在 Settings 中建立 API key。
2. 呼叫 列出 API 模型 選擇公開模型 ID。
3. 閱讀 模型 API 參考 查看該模型的參數。
4. 如果模型需要參考媒體，請使用 Files API 上傳。
5. 使用 建立生成任務 提交 job。
6. 輪詢 生成狀態，直到任務成功或失敗；也可以訂閱 API Webhooks 接收已簽名 completion events。
7. 對於聊天模型，請使用 Chat API，而不是 generation endpoint。Chat 圖片附件必須引用 Files API 的 file_id 值。

相關頁面

• API 快速開始
• API 驗證
• Rivya TypeScript SDK
• 模型 API 參考
• Chat API
• API Webhooks
• API 錯誤與限制