Tổng quan Rivya API

Rivya API v1 là hợp đồng dành cho nhà phát triển để gọi các khả năng mô hình Rivya được hỗ trợ từ sản phẩm của bạn khi Public API đã bật cho bản triển khai và khả dụng với tài khoản.

Hợp đồng đã triển khai bao gồm tạo hình ảnh, video và âm thanh bất đồng bộ, cùng lượt Chat API với phản hồi không truyền theo luồng hoặc SSE. Hợp đồng dùng ID mô hình Rivya, điểm tín dụng tài khoản, ID tác vụ công khai và phiên trò chuyện phía máy chủ. Một route được ghi nhận không đảm bảo mọi môi trường, tài khoản hay mô hình đều gọi được; hãy xác nhận quyền truy cập trực tiếp và trạng thái mô hình trước khi tích hợp.

API dùng để làm gì

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

• gửi job tạo nội dung hình ảnh, video hoặc âm thanh từ ứng dụng của riêng bạn

• gửi lượt trò chuyện không truyền theo luồng hoặc truyền theo luồng và tiếp tục trò chuyện phiêns do API tạo

• giữ phần tính phí trong cùng ví điểm tín dụng của tài khoản Rivya

• polling trạng thái tác vụ bằng công khai tác vụ ID

• dùng thử lại có idempotency cho các yêu cầu môi trường vận hành 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 điểm cuối v1 đã triển khai gồm:

• 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

Hợp đồng hiện tại gồm webhook đã ký cho kết quả tạo nội dung bất đồng bộ, Chat API và SDK TypeScript thử nghiệm hỗ trợ truyền theo luồng phía máy chủ. Lệnh gọi webhook yêu cầu tính năng webhook và Public API được bật cho bản triển khai.

Xác thực

Các điểm cuối tạo nội dung, trạng thái và điểm tín dụng 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 môi trường vận hành.

Mô hình tính phí

Lệnh gọi API dùng cùng Rivya tài khoản điểm tín dụng như Studio.

Các job tạo nội dung sẽ giữ trước hoặc tiêu thụ điểm tín dụng khi tác vụ bắt đầu. Mỗi lượt Chat giữ trước điểm tín dụng trước khi gọi mô hình và chốt cuối cùng điểm tín dụng dựa trên token usage khi assistant tin nhắn được lưu. Nếu một tạo nội dung hoặc trò chuyện 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 Điểm tín dụng API và Điểm tín dụng và thanh toán trong Rivya để hiểu mô hình ví điểm tín dụng 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 mô hình API để chọn công khai mô hình ID.

3. Đọc tham chiếu API của mô hình để xem tham số của mô hình.

4. Nếu mô hình cần tham chiếu media, hãy tải lên bằng Files API.

5. Gửi job bằng tạo tạo nội dung.

6. Polling Generation Status đến khi tác vụ thành công hoặc thất bại. Nếu webhook được bật cho bản triển khai và tài khoản, bạn có thể đăng ký sự kiện hoàn tất đã ký qua API Webhooks.

7. Với trò chuyện models, dùng Chat API thay vì tạo nội dung điểm cuối. 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 mô hình

• Chat API

• API Webhooks

• Lỗi và giới hạn API