К содержанию
Документация
APIСправочник

Справочник маршрутов

Маршруты и схемы, снятые с OpenAPI при сборке документации.

Файл сгенерирован командой yarn nx run api:export-openapi из декораторов API и Zod-схем. Вручную не редактируется.

Страницы ниже собраны из документа, который API строит из тех же Zod-схем и декораторов, что проверяют запросы. Живой сервер для чтения не нужен.

Базовый адрес — API продукта, локально http://localhost:3001. Путь /api/backend есть только у приложения: на хосте документации его нет, и примеры его не используют.

Маршруты диктовки /speech в этот документ не входят: у контроллера нет OpenAPI-декораторов.

Разделы

  • Генерация — 16. Подготовка шаблона, сборка трёх вариантов колоды, редактор и экспорт в PPTX, PDF, PNG и HTML.
  • Редактор — 6. Серверные снимки колоды из редактора: редакция, картинки и экспорт зафиксированной редакции.
  • Файлы и шаблоны — 8. Загрузка шаблона .pptx/.potx и материалов; библиотека шаблонов и их превью.
  • Чаты — 8. Разговор с ассистентом: ход отвечает потоком server-sent events.
  • Прогоны — 4. Состояние прогона и журнал его событий по этапам пайплайна.
  • Библиотека — 6. Проекты: папки для колод, чатов и шаблонов.
  • Модели — 9. Подключения к моделям и выбор модели для каждой роли пайплайна. Ключи наружу не уходят.
  • Пользователи — 10. Свой профиль и управление аккаунтами для администратора.
  • Вход — 4. Проверка пароля для веб-сервера, который держит сессию.
  • Состояние — 3. Живы ли API, движок и база данных.
  • Схемы — 140.

На этой странице