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 job hình ảnh, video và âm thanh bất đồng bộ, thêm lượt Chat API với SSE streaming 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 API key

Dạng quickstart

Lớp mô hình

Catalog động

Thanh toán

Tín dụng dùng chung

Phiên bản đầu

Jobs + Chat

Truy cập

API keys

MethodPOST
Endpoint/api/v1/generations

Request thật cần Rivya API key và tín dụng tài khoản còn khả dụng. Ví dụ công khai dùng placeholder secrets và không gọi mô hình ẩn danh.

Request
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"
  }'
Response
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

Những gì ship trước

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

API được thiết kế như một bề mặt sản phẩm Rivya. Nó dùng Rivya model IDs, Rivya credits, trạng thái tác vụ công khai và docs luôn kết nối với model catalog.

API tạo hình ảnh

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

API tạo video

Chạy job 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à usage trong Studio cùng trừ từ số dư Rivya, với tín dụng reserve và xử lý thất bại.

Đường bắt đầu

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

01

Tạo key

Đăng nhập, mở API Keys trong Settings, tạo scoped key và lưu full secret ngay lập tức.

02

Chọn mô hình

Đọc API model reference hoặc gọi /api/v1/models để kiểm tra model IDs, 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, poll hoặc subscribe

Gửi generation request idempotent, poll public task endpoint, dùng signed webhooks cho generation callbacks hoặc gửi một lượt Chat API với SSE streaming tùy chọn.

Ranh giới phiên bản

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

Landing page có thể nhắc tới bề mặt tương lai, nhưng copy sản phẩm hiện tại không được ám chỉ API chưa hoàn tất đã live.

Chat API

Khả dụng

Khả dụng cho lượt non-streaming và SSE streaming với phiên tạo bởi API, tín dụng tài khoản và Files API image attachments tùy chọn.

Files API

Khả dụng

Khả dụng cho upload ảnh, video và âm thanh tham chiếu. Dùng trước generation 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 production muốn signed callbacks cho tác vụ generation thành công hoặc thất bại.

Trình debug trực tuyến

Xem trước request, rồi chạy bằng API key của bạn

Debugger bắt đầu ở mock mode cho mọi visitor. Generation selector liệt kê các mô hình non-chat có thể test mà không upload file, còn Files panel cho người dùng đã đăng nhập test /api/v1/files bằng API key tạm thời. Ví dụ Chat nằm trong API docs.

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

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

Tiền tố khóa đang dùng

Tạo key 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ó API key active

Mock mode không bao giờ gọi mô hình và không tiêu tốn tín dụng.

Chỉ dán key cho request này. Debugger không lưu key sau khi refresh.

Test upload Files API

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

Mock không bao giờ uploadLive dùng /api/v1/files

Mô hình đã chọn kiểm soát MIME type, size và duration rules được phép. Live upload cần API key tạm thời của bạn và có thể gọi dịch vụ upload thật.

Tạo API keyĐọc API docs
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"
  }
}
Response
{
  "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 authentication, request bodies, responses, idempotency, model parameters và error codes.

Mở docs

Quản lý API key

Tạo, sao chép một lần, thu hồi và rotate API keys từ khu vực Settings được bảo vệ.

Quản lý keys

Debug online

Dùng mock examples trước; debugging thật cần đăng nhập, API key và tín dụng tài khoản.

Xem trước luồng