Просматривайте модели Rivya API, разбирайтесь в ID моделей, категориях, лимитах промптов, справочных медиа, состояниях готовности и зависимостях Files API.

Используйте GET /api/v1/models, чтобы получить список моделей Rivya с их готовностью для Public API.

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

Эта конечная точка публичная и только для чтения. Она возвращает тот же публичный слой моделей, который используется документацией 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 для асинхронных моделей генерации. Для моделей чата используйте POST /api/v1/chat/completions и проверяйте chat_capabilities.

Состояния доступности

Справочник моделей использует такие публичные состояния:

available: доступен как минимум один путь генерации через Public API
coming_soon: асинхронная модель генерации, но сейчас она не открыта через Public API
studio_only: модель доступна через Studio или другую поверхность продукта, но не через Public API v1

Поле готовности входных данных более конкретное:

available_text: запросы на основе промпта можно тестировать напрямую
available_url_input: публичный URL или скалярные params можно тестировать напрямую
partial_requires_files: некоторые режимы можно вызывать без загрузки; режимы со справочными медиа должны использовать Files API
requires_files_api: модель зависит от справочных медиа, загруженных через /api/v1/files

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

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

Политика количества моделей

Публичный список моделей меняется, когда Rivya добавляет, удаляет или ограничивает модели.

Не полагайтесь в интеграции на жестко заданное количество моделей. Всегда читайте /api/v1/models или динамический справочник Model API.

Модели API

Форма ответа

Состояния доступности

Политика количества моделей

Связанные страницы

Содержание