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

Генерация

Подготовка шаблона, сборка трёх вариантов колоды, редактор и экспорт в PPTX, PDF, PNG и HTML.

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

Подготовка шаблона, сборка трёх вариантов колоды, редактор и экспорт в PPTX, PDF, PNG и HTML.

GET /generation

Колоды библиотеки Одна запись на сборку: вариант, выбранный в чате, или первый готовый.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.

Ответы

КодОписаниеСхема
200Успешно.array<LibraryDeck>
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError

POST /generation

Собрать колоду Запускает три варианта вёрстки (dense, balanced, airy) по одному плану. Ответ приходит сразу; ход каждого варианта — в GET /runs/{runId}/events. Бюджет на три варианта — 5 минут.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.

Тело запроса

Ответы

КодОписаниеСхема
201Создано или запущено.StartedBuild
400Неверный запрос: тело или параметры не прошли проверку.ApiError
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError
503Недоступен движок, база данных или хранилище ключей.ApiError

DELETE /generation/{id}

Удалить колоду Вместе с остальными вариантами сборки.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
idpathдаid готового варианта колоды.

Ответы

КодОписаниеСхема
204Колода удалена.—
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

PATCH /generation/{id}

Переименовать или перенести колоду Все варианты сборки меняются вместе. projectId: null — вынести из проекта.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
idpathдаid готового варианта колоды.

Тело запроса

Ответы

КодОписаниеСхема
200Успешно.Ok
400Неверный запрос: тело или параметры не прошли проверку.ApiError
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

GET /generation/{id}/artifacts/{name}

Скачать артефакт сборки Файл, каким его собрал пайплайн.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
namepathдаslide-N.png — превью слайда N.
idpathдаid готового варианта колоды.

Ответы

КодОписаниеСхема
200Артефакт.string
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

POST /generation/{id}/cancel

Остановить сборку Варианты, которые ещё идут, прерываются.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
idpathдаid готового варианта колоды.

Ответы

КодОписаниеСхема
201Создано или запущено.Ok
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

GET /generation/{id}/deck

Колода для редактора Дизайн-система, IR шаблона и слайды, прочитанные обратно из .pptx. Если движок не смог прочитать файл, slides нет и редактор собирает их из IR шаблона.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
idpathда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-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
idpathдаid готового варианта колоды.

Тело запроса

Ответы

КодОписаниеСхема
201Создано или запущено.ExportedDeck
400Неверный запрос: тело или параметры не прошли проверку.ApiError
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError
503Недоступен движок, база данных или хранилище ключей.ApiError

GET /generation/{id}/exports/{exportId}/{name}

Скачать экспорт Файл, собранный POST /generation/{id}/export.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
namepathда
exportIdpathда
idpathдаid готового варианта колоды.

Ответы

КодОписаниеСхема
200Файл экспорта.string
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

GET /generation/{id}/media/{name}

Картинка колоды Изображения слайдов для редактора.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
namepathда
idpathдаid готового варианта колоды.

Ответы

КодОписаниеСхема
200Изображение.string
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

GET /generation/{id}/previews

Превью слайдов Имена файлов; сами файлы — в artifacts.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
idpathдаid готового варианта колоды.

Ответы

КодОписаниеСхема
200Успешно.array<string>
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

POST /generation/{id}/resume

Продолжить сборку с сохранённых задач

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.

Ответы

КодОписаниеСхема
201Создано или запущено.—
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError

GET /generation/{id}/summary

Сводка колоды для карточки чата Без повторного чтения .pptx: обложка уже нарисована.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
idpathдаid готового варианта колоды.

Ответы

КодОписаниеСхема
200Успешно.DeckSummary
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

GET /generation/{id}/usage

Накопленный расход сборки, включая неудачные попытки и продолжения

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.

Ответы

КодОписаниеСхема
200Успешно.—
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError

POST /generation/prepare

Подготовить шаблон Один раз на шаблон и вне бюджета генерации: профиль, описание каждого макета моделью и превью слайдов. Отвечает, когда шаблон готов; повторный вызов для готового шаблона возвращается сразу.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.

Тело запроса

Ответы

КодОписаниеСхема
201Создано или запущено.object
400Неверный запрос: тело или параметры не прошли проверку.ApiError
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError
503Недоступен движок, база данных или хранилище ключей.ApiError

GET /generation/prepare/{templateId}

Ход подготовки шаблона Этап и сколько макетов описано; страница, открытая посреди подготовки, следит за ней.

Параметры

ИмяГдеОбязателенОписание
x-lct-sessionheaderдаСерверный session token из /auth/verify. Отзывается при logout и изменении доступа.
templateIdpathда

Ответы

КодОписаниеСхема
200Успешно.TemplatePreparation
400Неверный запрос: тело или параметры не прошли проверку.ApiError
401Нет входа: аккаунт не назван, удалён или отключён.ApiError
403Нет прав: запрос не от веб-сервера или действие только для администратора.ApiError
404Объекта нет или он принадлежит другому аккаунту.ApiError

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