Tổng quan Rivya API

Rivya API v1 là điểm vào dành cho nhà phát triển để gọi năng lực mô hình Rivya từ sản phẩm của bạn.

Public API hỗ trợ generation hình ảnh, video và âm thanh bất đồng bộ, cùng các lượt Chat API với phản hồi không streaming hoặc SSE streaming. API dùng Rivya model IDs, Rivya account credits, public task IDs cho generation và chat sessions phía server cho Chat API.

API dùng để làm gì

Dùng API khi bạn muốn:

• gửi job generation hình ảnh, video hoặc âm thanh từ ứng dụng của riêng bạn
• gửi lượt chat không streaming hoặc streaming và tiếp tục chat sessions do API tạo
• giữ phần tính phí trong cùng ví credits của tài khoản Rivya
• polling trạng thái task bằng public task ID
• dùng retry có idempotency cho các request production an toàn hơn
• giữ Studio và API usage trong cùng ranh giới tài khoản

API là một lớp sản phẩm của Rivya. Public responses chỉ dùng tên và trường công khai của Rivya.

Phạm vi phiên bản hiện tại

Các endpoint v1 hiện tại:

• 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

Phiên bản hiện tại bao gồm webhook có chữ ký cho kết quả generation bất đồng bộ, Chat API và TypeScript SDK beta có hỗ trợ streaming phía server.

Xác thực

Các endpoint generation, status và credits yêu cầu:

Authorization: Bearer rvya_sk_...

Tạo và rotate key trong cài đặt API Keys. Hãy đọc Xác thực API trước khi dùng key trong production.

Mô hình tính phí

Lệnh gọi API dùng cùng Rivya account credits như Studio.

Các job generation sẽ giữ trước hoặc tiêu thụ credits khi task bắt đầu. Mỗi lượt Chat giữ trước credits trước khi gọi mô hình và chốt final credits dựa trên token usage khi assistant message được lưu. Nếu một generation hoặc chat turn thất bại theo các quy tắc lỗi hiện có của Rivya, cách xử lý refund tương tự sẽ được áp dụng.

Đọc Credits API và Credits và thanh toán trong Rivya để hiểu mô hình ví credits mà người dùng nhìn thấy.

Lộ trình tích hợp đầu tiên

1. Tạo API key trong Settings.
2. Gọi danh sách model API để chọn public model ID.
3. Đọc tham chiếu API của model để xem parameters của mô hình.
4. Nếu mô hình cần reference media, hãy upload bằng Files API.
5. Gửi job bằng tạo generation.
6. Poll trạng thái generation cho đến khi task thành công hoặc thất bại, hoặc đăng ký API Webhooks để nhận event hoàn tất có chữ ký.
7. Với chat models, dùng Chat API thay vì generation endpoint. File đính kèm hình ảnh trong Chat phải tham chiếu giá trị Files API file_id.

Trang liên quan

• Bắt đầu nhanh với API
• Xác thực API
• Rivya TypeScript SDK
• Tham chiếu API của model
• Chat API
• API Webhooks
• Lỗi và giới hạn API