Генерация
Подготовка шаблона, сборка трёх вариантов колоды, редактор и экспорт в PPTX, PDF, PNG и HTML.
Файл сгенерирован командой
yarn nx run api:export-openapiиз декораторов API и Zod-схем. Вручную не редактируется.
Подготовка шаблона, сборка трёх вариантов колоды, редактор и экспорт в PPTX, PDF, PNG и HTML.
GET /generation
Колоды библиотеки Одна запись на сборку: вариант, выбранный в чате, или первый готовый.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | array<LibraryDeck> |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
POST /generation
Собрать колоду
Запускает три варианта вёрстки (dense, balanced, airy) по одному плану. Ответ приходит сразу; ход каждого варианта — в GET /runs/{runId}/events. Бюджет на три варианта — 5 минут.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Тело запроса
application/json— GenerationRequest
Ответы
| Код | Описание | Схема |
|---|---|---|
| 201 | Создано или запущено. | StartedBuild |
| 400 | Неверный запрос: тело или параметры не прошли проверку. | ApiError |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
| 503 | Недоступен движок, база данных или хранилище ключей. | ApiError |
DELETE /generation/{id}
Удалить колоду Вместе с остальными вариантами сборки.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
id | path | да | id готового варианта колоды. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 204 | Колода удалена. | — |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
PATCH /generation/{id}
Переименовать или перенести колоду
Все варианты сборки меняются вместе. projectId: null — вынести из проекта.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
id | path | да | id готового варианта колоды. |
Тело запроса
application/json— DeckPatch
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | Ok |
| 400 | Неверный запрос: тело или параметры не прошли проверку. | ApiError |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
GET /generation/{id}/artifacts/{name}
Скачать артефакт сборки Файл, каким его собрал пайплайн.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
name | path | да | slide-N.png — превью слайда N. |
id | path | да | id готового варианта колоды. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Артефакт. | string |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
POST /generation/{id}/cancel
Остановить сборку Варианты, которые ещё идут, прерываются.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
id | path | да | id готового варианта колоды. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 201 | Создано или запущено. | Ok |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
GET /generation/{id}/deck
Колода для редактора
Дизайн-система, IR шаблона и слайды, прочитанные обратно из .pptx. Если движок не смог прочитать файл, slides нет и редактор собирает их из IR шаблона.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
id | path | да | id готового варианта колоды. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | object |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
POST /generation/{id}/export
Экспорт отредактированной колоды
Движок заново собирает нативный PPTX из слайдов редактора, поэтому скачанный файл совпадает с тем, что на экране. PDF, PNG и HTML строятся из него же. Файлы — в GET /generation/{id}/exports/{exportId}/{name}.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
id | path | да | id готового варианта колоды. |
Тело запроса
application/json— ExportRequest
Ответы
| Код | Описание | Схема |
|---|---|---|
| 201 | Создано или запущено. | ExportedDeck |
| 400 | Неверный запрос: тело или параметры не прошли проверку. | ApiError |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
| 503 | Недоступен движок, база данных или хранилище ключей. | ApiError |
GET /generation/{id}/exports/{exportId}/{name}
Скачать экспорт
Файл, собранный POST /generation/{id}/export.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
name | path | да | |
exportId | path | да | |
id | path | да | id готового варианта колоды. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Файл экспорта. | string |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
GET /generation/{id}/media/{name}
Картинка колоды Изображения слайдов для редактора.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
name | path | да | |
id | path | да | id готового варианта колоды. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Изображение. | string |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
GET /generation/{id}/previews
Превью слайдов
Имена файлов; сами файлы — в artifacts.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
id | path | да | id готового варианта колоды. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | array<string> |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
POST /generation/{id}/resume
Продолжить сборку с сохранённых задач
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 201 | Создано или запущено. | — |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
GET /generation/{id}/summary
Сводка колоды для карточки чата
Без повторного чтения .pptx: обложка уже нарисована.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
id | path | да | id готового варианта колоды. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | DeckSummary |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
GET /generation/{id}/usage
Накопленный расход сборки, включая неудачные попытки и продолжения
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | — |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
POST /generation/prepare
Подготовить шаблон Один раз на шаблон и вне бюджета генерации: профиль, описание каждого макета моделью и превью слайдов. Отвечает, когда шаблон готов; повторный вызов для готового шаблона возвращается сразу.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
Тело запроса
application/json— PrepareRequest
Ответы
| Код | Описание | Схема |
|---|---|---|
| 201 | Создано или запущено. | object |
| 400 | Неверный запрос: тело или параметры не прошли проверку. | ApiError |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |
| 503 | Недоступен движок, база данных или хранилище ключей. | ApiError |
GET /generation/prepare/{templateId}
Ход подготовки шаблона Этап и сколько макетов описано; страница, открытая посреди подготовки, следит за ней.
Параметры
| Имя | Где | Обязателен | Описание |
|---|---|---|---|
x-lct-session | header | да | Серверный session token из /auth/verify. Отзывается при logout и изменении доступа. |
templateId | path | да |
Ответы
| Код | Описание | Схема |
|---|---|---|
| 200 | Успешно. | TemplatePreparation |
| 400 | Неверный запрос: тело или параметры не прошли проверку. | ApiError |
| 401 | Нет входа: аккаунт не назван, удалён или отключён. | ApiError |
| 403 | Нет прав: запрос не от веб-сервера или действие только для администратора. | ApiError |
| 404 | Объекта нет или он принадлежит другому аккаунту. | ApiError |