API-моделі

Використовуйте GET /api/v1/models, щоб отримати список моделей Rivya з їхньою готовністю для Public API.

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

Цей endpoint є публічним і доступним лише для читання. Він повертає той самий публічний шар моделей, який використовують API-документи й онлайн-налагоджувач, включно з моделями, які ще не повністю доступні для виклику.

Структура відповіді

Відповідь має таку форму:

{
  "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": []
    }
  ]
}

Використовуйте id як значення model у POST /api/v1/generations для асинхронних моделей генерації. Для chat-моделей використовуйте POST /api/v1/chat/completions і перевіряйте chat_capabilities.

Стани доступності

Довідник моделей використовує такі публічні стани:

• available: доступний щонайменше один шлях генерації через Public API

• temporarily_unavailable: модель тимчасово недоступна, і зараз її не можна викликати через Public API v1

• studio_only: модель доступна через Studio або інший розділ продукту, але не через Public API v1

Поле готовності входу є конкретнішим:

• available_text: запити на основі prompt можна тестувати напряму

• available_url_input: публічний URL або скалярні params можна тестувати напряму

• partial_requires_files: деякі режими можна викликати без завантаження; режими з референс-медіа мають використовувати Files API

• requires_files_api: модель залежить від референс-медіа, завантажених через /api/v1/files

Перед викликом режимів, які потребують завантажених зображень, відео або аудіореференсів, використовуйте Files API.

Для chat-моделей chat_capabilities документує, чи підтримує Chat API відповіді без потокового передавання, потокове передавання, web search, вкладення зображень через file_id, режим думок і керування зусиллям міркування.

Політика кількості моделей

Публічний список моделей змінюється, коли Rivya додає, вилучає або обмежує моделі.

Не покладайтеся на жорстко задану кількість моделей у своїй інтеграції. Завжди читайте /api/v1/models або динамічний Model API Reference.

Пов'язані сторінки

• Model API Reference

• Створення генерації

• Chat API

• Посібник із вибору моделей Rivya

• Доступність моделей у Rivya

Записи «Незабаром» лише для читання

• coming_soon: модель доступна лише для ознайомлення й не приймається API генерації або чату. Вона повертає supports_direct_generation: false, null для runtime, billing і pricing та порожні supported_modes і params. Для запитів обирайте api_status: available.