Rivya API

Xây dựng trên lớp mô hình đa phương thức của Rivya

Rivya API cho đội sản phẩm một cách công khai, theo tài khoản, để gọi mô hình Rivya từ ứng dụng riêng. Bắt đầu với tác vụ hình ảnh, video và âm thanh bất đồng bộ, thêm lượt Chat API với truyền phát SSE tùy chọn khi mô hình hỗ trợ chat, và giữ thanh toán trong cùng ví tín dụng Rivya.
Đọc tài liệu APITạo khóa API

Dạng khởi động nhanh

Lớp mô hình

Catalog động

Thanh toán

Tín dụng dùng chung

Phiên bản đầu

Tác vụ + Chat

Truy cập

Khóa API

Phương thứcPOST
Điểm cuối/api/v1/generations

Yêu cầu thật cần khóa Rivya API và tín dụng tài khoản còn khả dụng. Ví dụ công khai dùng bí mật placeholder và không gọi mô hình ẩn danh.

Yêu cầu
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'
Phản hồi
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "result": null,
  "error": null
}

Những gì phát hành trước

Một lớp API công khai luôn khớp với sản phẩm Rivya

API là một phần của sản phẩm Rivya. API sử dụng ID mô hình Rivya, tín dụng Rivya, trạng thái tác vụ công khai và tài liệu gắn với danh mục mô hình.

API tạo hình ảnh

Gửi tác vụ hình ảnh với prompt và tham số mô hình được hỗ trợ, rồi thăm dò để lấy kết quả công khai.

API tạo video

Chạy tác vụ video bất đồng bộ với cùng điều khiển tác vụ và tín dụng được Studio dùng.

API tạo âm thanh

Dùng các mô hình âm thanh có thể truy cập qua API trong cùng ranh giới tài khoản, số dư và lịch sử.

Ví tín dụng dùng chung

Lệnh gọi API và mức sử dụng trong Studio cùng trừ từ số dư Rivya, với tín dụng giữ trước và xử lý thất bại.

Đường bắt đầu

Từ tài khoản tới yêu cầu API đầu tiên

01

Tạo khóa

Đăng nhập, mở API Keys trong phần Cài đặt, tạo khóa có phạm vi và lưu bí mật đầy đủ ngay lập tức.

02

Chọn mô hình

Đọc tham chiếu mô hình API hoặc gọi /api/v1/models để kiểm tra ID mô hình, tham số, năng lực chat và mức sẵn sàng đầu vào trước khi gửi.

03

Gửi, thăm dò hoặc đăng ký

Gửi yêu cầu tạo có khóa bất biến khi gửi lặp, thăm dò endpoint tác vụ công khai, dùng webhook có chữ ký cho callback tạo nội dung hoặc gửi một lượt Chat API với truyền phát SSE tùy chọn.

Ranh giới phiên bản

Phạm vi rõ ràng, không hứa ngầm

Trang này tách rõ các khả năng API hiện có và những phần sẽ bổ sung trong tương lai, giúp bạn lập kế hoạch dựa trên những gì đang hoạt động hôm nay.

Chat API

Khả dụng

Khả dụng cho lượt không truyền phát và truyền phát SSE với phiên tạo bởi API, tín dụng tài khoản và tệp đính kèm hình ảnh Files API tùy chọn.

Files API

Khả dụng

Khả dụng cho tải ảnh, video và âm thanh tham chiếu lên. Dùng trước khi tạo khi trang mô hình yêu cầu params.referenceMediaItems.

Webhook người dùng

Khả dụng

Khả dụng cho tích hợp sản xuất muốn callback có chữ ký cho tác vụ tạo thành công hoặc thất bại.

Trình gỡ lỗi trực tuyến

Xem trước yêu cầu, rồi chạy bằng khóa API của bạn

Trình gỡ lỗi bắt đầu ở chế độ mô phỏng cho mọi khách truy cập. Bộ chọn tạo nội dung liệt kê các mô hình không phải chat có thể kiểm thử mà không cần tải tệp lên, còn bảng Files cho người dùng đã đăng nhập kiểm thử /api/v1/files bằng khóa API tạm thời. Ví dụ Chat nằm trong tài liệu API.

Trạng thái tài khoản

Đang kiểm tra tài khoản

Tiền tố khóa đang hoạt động

Tạo khóa trước

Tín dụng hiện tại

Đăng nhập để kiểm tra

Xem trước giả lậpPublic API trực tiếpKhông có khóa API đang hoạt động

Chế độ mô phỏng không bao giờ gọi mô hình và không tiêu tốn tín dụng.

Chỉ dán khóa cho yêu cầu này. Trình gỡ lỗi không lưu khóa sau khi làm mới.

Kiểm thử tải lên Files API

Tải media tham chiếu qua POST /api/v1/files, rồi sao chép URL và token thời lượng trả về vào params.referenceMediaItems cho mô hình hỗ trợ đầu vào tham chiếu.

Mô phỏng không bao giờ tải lênTrực tiếp dùng /api/v1/files

Mô hình đã chọn kiểm soát MIME type, kích thước và quy tắc thời lượng được phép. Tải lên trực tiếp cần khóa API tạm thời của bạn và có thể gọi dịch vụ tải lên thật.

Tạo khóa APIĐọc tài liệu API
Xem trước yêu cầu
{
  "model": "z-image",
  "prompt": "Ảnh sản phẩm biên tập trên bối cảnh studio gọn gàng",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Phản hồi
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Phản hồi Files API
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
Tham số tạo
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Trạng thái tác vụ

Tín dụng cơ bản ước tính

1

Trạng thái

queued

Tài liệu API

Đọc xác thực, thân yêu cầu, phản hồi, cơ chế chống gửi lặp, tham số mô hình và mã lỗi.

Mở tài liệu

Quản lý khóa API

Tạo, sao chép một lần, thu hồi và xoay vòng khóa API từ khu vực Cài đặt được bảo vệ.

Quản lý khóa

Gỡ lỗi trực tuyến

Dùng ví dụ mô phỏng trước; gỡ lỗi thật cần đăng nhập, khóa API và tín dụng tài khoản.

Xem trước luồng