API

Справочник маршрутов и схем генерируется при сборке документации из декораторов Nest и Zod-схем. Читать его можно при выключенном API, PostgreSQL и движке.

Интерактивной консоли в этом выпуске нет. Кнопка «Try it out» живого приложения сюда не переносится: на поддомене документации относительный путь /api/backend указывал бы на сам портал, а не на продукт.

СтраницыКопировать ссылку

• Доступ и ошибки — сессия, заголовки, коды.
• Справочник — маршруты по разделам и каталог схем.
• Файл openapi.json лежит в корне опубликованного сайта. Это снимок сборки, не ответ живого сервера.

Базовый адрес API продукта локально — http://localhost:3001. Браузер туда не ходит.

Маршруты диктовки /speech в OpenAPI не описаны: у контроллера нет декораторов. Их нет и в справочнике, чтобы не выдумывать тела запросов.

Примеры интеграций — curl и клиент на своём хосте — появятся отдельной статьёй. Секреты в примерах не публикуются: ни API_SERVICE_TOKEN, ни токен сессии.