API
Документы (SmartDoc)
Документы — AI-инструменты
AI-функции в редакторе документов.
Документы — коллаборация
Realtime-collaboration в редакторе (Yjs).
Документы
Создание и управление документами.
Документы — папки
Папки документов.
Документы — импорт и экспорт
Импорт и экспорт документов в DOCX/PDF.
Документы — прогресс импорта
Стриминг прогресса импорта документов (SSE-тикеты).
Документы — связи с реестрами
Связи документов с записями реестров.
Документы — блоки и роли
Схемы и шаблоны документов.
Документы — доступ
Управление доступом к документам.
Операции
Всего операций: 68. Полные схемы запросов и ответов — на страницах разделов.
Документы — AI-инструменты
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/smartdoc/ai/transform | ИИ-обработка текста |
Документы — коллаборация
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/smartdoc/documents/{id}/comments/notify | Уведомить о новом комментарии к документу (публикует Kafka event) |
GET | /api/v1/smartdoc/documents/{id}/yjs | Получить Yjs CRDT-состояние документа (merged, бинарь) |
Документы
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/smartdoc/blocks/batch | Получить блоки по списку id |
POST | /api/v1/smartdoc/blocks/parent-documents | Родительские документы для блоков |
GET | /api/v1/smartdoc/blocks/{blockId} | Получить блок по id |
GET | /api/v1/smartdoc/blocks/{blockId}/references | Ссылки на блок из других документов |
GET | /api/v1/smartdoc/documents | Список документов |
POST | /api/v1/smartdoc/documents | Создать документ |
POST | /api/v1/smartdoc/documents/from-template | Создать документ из шаблона |
DELETE | /api/v1/smartdoc/documents/{id} | Удалить документ |
GET | /api/v1/smartdoc/documents/{id} | Получить документ |
PUT | /api/v1/smartdoc/documents/{id} | Обновить документ |
POST | /api/v1/smartdoc/documents/{id}/blocks | Добавить блок в документ |
DELETE | /api/v1/smartdoc/documents/{id}/blocks/{blockId} | Удалить блок документа |
PATCH | /api/v1/smartdoc/documents/{id}/blocks/{blockId} | Обновить блок документа |
POST | /api/v1/smartdoc/documents/{id}/copy | Копировать документ |
POST | /api/v1/smartdoc/documents/{id}/link | Связать дочерний документ |
PATCH | /api/v1/smartdoc/documents/{id}/move | Переместить документ в папку |
POST | /api/v1/smartdoc/documents/{id}/project-now | Синхронно спроецировать накопленные Yjs-правки в блоки |
POST | /api/v1/smartdoc/documents/{id}/restore/{versionId} | Восстановить документ из версии |
POST | /api/v1/smartdoc/documents/{id}/save | Сохранить документ целиком |
GET | /api/v1/smartdoc/documents/{id}/suggestions | Нерассмотренные предложения агента |
POST | /api/v1/smartdoc/documents/{id}/suggestions/resolve-all | Принять или отклонить все предложения агента |
POST | /api/v1/smartdoc/documents/{id}/suggestions/{suggestionId}/accept | Принять предложение агента |
POST | /api/v1/smartdoc/documents/{id}/suggestions/{suggestionId}/reject | Отклонить предложение агента |
POST | /api/v1/smartdoc/documents/{id}/unlink | Отвязать дочерний документ |
GET | /api/v1/smartdoc/documents/{id}/versions | Версии документа |
POST | /api/v1/smartdoc/documents/{id}/versions | Создать версию документа |
GET | /api/v1/smartdoc/documents/{id}/versions/compare | Сравнить две версии документа |
GET | /api/v1/smartdoc/documents/{id}/versions/{versionId} | Получить версию документа |
GET | /api/v1/smartdoc/documents/{id}/versions/{versionId}/compare-current | Сравнить версию с текущим состоянием |
POST | /api/v1/smartdoc/resync | Пересинхронизировать документы команды |
Документы — папки
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/smartdoc/folders | Список папок |
POST | /api/v1/smartdoc/folders | Создать папку |
DELETE | /api/v1/smartdoc/folders/{id} | Удалить папку |
GET | /api/v1/smartdoc/folders/{id} | Получить папку |
PUT | /api/v1/smartdoc/folders/{id} | Обновить папку |
PATCH | /api/v1/smartdoc/folders/{id}/move | Переместить папку |
Документы — импорт и экспорт
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/smartdoc/analyze-file | Проанализировать файл перед импортом |
GET | /api/v1/smartdoc/documents/{id}/export/docx | Экспорт документа в DOCX |
GET | /api/v1/smartdoc/documents/{id}/export/pdf | Экспорт документа в PDF (скачивание) |
POST | /api/v1/smartdoc/documents/{id}/export/pdf | Экспорт документа в PDF (просмотр, с фирменным бланком) |
POST | /api/v1/smartdoc/import | Импортировать документ из файла (PDF/DOCX) |
POST | /api/v1/smartdoc/import/html | Импортировать документ из HTML |
GET | /api/v1/smartdoc/import/{jobId}/status | Статус задачи импорта |
Документы — прогресс импорта
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/smartdoc/import/{jobId}/stream-ticket | Выпустить одноразовый тикет для подписки на SSE-стрим импорта |
Документы — связи с реестрами
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/smartdoc/documents/{documentId}/links | Связи документа с записями реестров |
POST | /api/v1/smartdoc/documents/{documentId}/links | Привязать запись реестра к документу |
DELETE | /api/v1/smartdoc/documents/{documentId}/links/{linkId} | Удалить связь документа |
GET | /api/v1/smartdoc/registry/{typeId}/records/{recordId}/documents | Документы, привязанные к записи реестра |
Документы — блоки и роли
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/smartdoc/schemas/blocks | Типы блоков SmartDoc |
GET | /api/v1/smartdoc/schemas/blocks/{type} | Детали типа блока |
GET | /api/v1/smartdoc/schemas/contract-roles | Карта ролей сторон по типам договоров |
GET | /api/v1/smartdoc/schemas/contract-roles/{contractType} | Роли сторон для типа договора |
Документы — доступ
| Метод | Путь | Операция |
|---|---|---|
DELETE | /api/v1/smartdoc/documents/{id}/share-invites/{inviteId} | Отменить приглашение к документу |
GET | /api/v1/smartdoc/documents/{id}/shares | Доступы к документу |
POST | /api/v1/smartdoc/documents/{id}/shares | Выдать доступ к документу |
POST | /api/v1/smartdoc/documents/{id}/shares/by-email | Расшарить документ по email |
DELETE | /api/v1/smartdoc/documents/{id}/shares/{shareId} | Отозвать доступ к документу |
PATCH | /api/v1/smartdoc/documents/{id}/shares/{shareId} | Изменить доступ к документу |
DELETE | /api/v1/smartdoc/folders/{id}/share-invites/{inviteId} | Отменить приглашение к папке |
GET | /api/v1/smartdoc/folders/{id}/shares | Доступы к папке |
POST | /api/v1/smartdoc/folders/{id}/shares | Выдать доступ к папке |
POST | /api/v1/smartdoc/folders/{id}/shares/by-email | Расшарить папку по email |
DELETE | /api/v1/smartdoc/folders/{id}/shares/{shareId} | Отозвать доступ к папке |
PATCH | /api/v1/smartdoc/folders/{id}/shares/{shareId} | Изменить доступ к папке |
GET | /api/v1/smartdoc/shared-with-me | Документы и папки, расшаренные текущему пользователю |