Mô hình API

Dùng GET /api/v1/models để liệt kê các mô hình Rivya cùng trạng thái sẵn sàng cho Public API.

curl https://rivya.ai/api/v1/models

Endpoint này công khai và chỉ đọc. Nó trả về cùng lớp mô hình công khai mà tài liệu API và trình debug trực tuyến sử dụng, bao gồm cả các mô hình chưa thể gọi đầy đủ.

Cấu trúc phản hồi

Phản hồi dùng cấu trúc này:

{
  "object": "list",
  "data": [
    {
      "id": "z-image",
      "display_name": "Z-Image",
      "category": "image",
      "runtime": "async_task",
      "base_credits": 1,
      "billing_type": "FIXED",
      "supported_modes": ["text-to-image"],
      "max_prompt_length": 1000,
      "reference_media": null,
      "params": [],
      "api_status": "available",
      "api_input_status": "available_text",
      "supported_api_inputs": ["text"],
      "requires_files_api": false,
      "requires_upload_for_modes": [],
      "url_input_supported": false,
      "file_kinds": [],
      "chat_capabilities": null,
      "notices": []
    }
  ]
}

Dùng id làm giá trị model trong POST /api/v1/generations cho các mô hình generation bất đồng bộ. Với mô hình chat, dùng POST /api/v1/chat/completions và kiểm tra chat_capabilities.

Trạng thái khả dụng

Tham chiếu mô hình dùng các trạng thái công khai này:

• available: ít nhất một đường generation Public API khả dụng

• temporarily_unavailable: mô hình tạm thời không khả dụng và hiện không thể gọi qua Public API v1

• studio_only: mô hình khả dụng qua Studio hoặc khu vực khác trong sản phẩm, không qua Public API v1

Trường sẵn sàng input cụ thể hơn:

• available_text: yêu cầu dựa trên prompt có thể kiểm thử trực tiếp

• available_url_input: URL công khai hoặc scalar params có thể kiểm thử trực tiếp

• partial_requires_files: một số mode có thể gọi mà không cần upload; các mode reference-media nên dùng Files API

• requires_files_api: mô hình phụ thuộc media tham chiếu được tải lên qua /api/v1/files

Dùng Files API trước khi gọi các mode cần ảnh, video hoặc âm thanh tham chiếu đã tải lên.

Với mô hình chat, chat_capabilities ghi rõ Chat API có hỗ trợ phản hồi không streaming, phản hồi streaming, web search, ảnh đính kèm bằng file_id, thoughts và reasoning effort hay không.

Chính sách số lượng mô hình

Danh sách mô hình công khai thay đổi khi Rivya thêm, gỡ hoặc giới hạn mô hình.

Đừng dựa vào số lượng mô hình hard-code trong tích hợp của bạn. Luôn đọc /api/v1/models hoặc Tham chiếu API mô hình động.

Trang liên quan

• Tham chiếu API mô hình

• Tạo generation

• Chat API

• Hướng dẫn chọn mô hình Rivya

• Khả dụng mô hình trong Rivya

Mục Sắp ra mắt chỉ đọc

• coming_soon: mô hình chỉ được liệt kê để khám phá và không thể gửi tới API tạo nội dung hoặc Chat. Mục này trả về supports_direct_generation: false, runtime, thanh toán và giá trị giá là null, cùng supported_modes và params rỗng. Hãy chọn api_status: available cho yêu cầu.