mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
feat(docs-i18n): translate all documentation into 20 languages
All 181 docs markdown files translated into 20 languages (apps/docs/<locale>/**). Companion to the i18n code PR; admin-merged because the file count exceeds GitHub's per-PR CI trigger limit. Validated by pnpm i18n:check (all surfaces, 0 stale/missing) and a clean all-locale docs build.
This commit is contained in:
@@ -0,0 +1,438 @@
|
||||
---
|
||||
description: "Справочник по AI-движку со всеми локальными ML-инструментами. Удаление фона, апскейлинг, OCR, распознавание лиц, реставрация фотографий и другое."
|
||||
i18n_source_hash: 14728c1dcd05
|
||||
i18n_provenance: machine
|
||||
i18n_output_hash: 362d36a75c8d
|
||||
---
|
||||
|
||||
# Справочник по AI-движку {#ai-engine-reference}
|
||||
|
||||
Пакет `@snapotter/ai` связывает Node.js с **постоянным Python-сайдкаром** для всех ML-операций. Процесс диспетчера остаётся активным между запросами, обеспечивая быстрый тёплый старт. NVIDIA CUDA автоматически определяется при запуске и используется, если доступна; иначе AI-инструменты работают на CPU.
|
||||
|
||||
Ускорение через iGPU Intel/AMD посредством VA-API, Quick Sync или OpenCL сегодня не поддерживается для AI-инференса. Проброс `/dev/dri` в контейнер не ускоряет эти инструменты Python-сайдкара, если не доступна NVIDIA GPU с поддержкой CUDA.
|
||||
|
||||
19 AI-инструментов Python-сайдкара в четырёх модальностях (изображение, аудио, видео, документ) плюс 2 инструмента с опциональными AI-возможностями. Все модели работают локально: после первоначальной загрузки моделей интернет не требуется.
|
||||
|
||||
## Архитектура {#architecture}
|
||||
|
||||
```
|
||||
Node.js Tool Route
|
||||
|
|
||||
v
|
||||
@snapotter/ai bridge.ts
|
||||
| (stdin/stdout JSON + stderr progress events)
|
||||
v
|
||||
Python dispatcher (persistent process, "ai" profile)
|
||||
|
|
||||
|-- remove_bg.py (rembg / BiRefNet)
|
||||
|-- upscale.py (RealESRGAN)
|
||||
|-- inpaint.py (LaMa ONNX)
|
||||
|-- outpaint.py (LaMa canvas expansion)
|
||||
|-- ocr.py (PaddleOCR / Tesseract)
|
||||
|-- ocr_pdf.py (page-by-page document OCR)
|
||||
|-- ocr_preprocess.py (image enhancement for OCR)
|
||||
|-- detect_faces.py (MediaPipe)
|
||||
|-- face_landmarks.py (MediaPipe landmarks)
|
||||
|-- enhance_faces.py (GFPGAN / CodeFormer)
|
||||
|-- colorize.py (DDColor)
|
||||
|-- noise_removal.py (SCUNet / tiered denoising)
|
||||
|-- red_eye_removal.py (landmark + color analysis)
|
||||
|-- restore.py (scratch repair + enhancement + denoising)
|
||||
|-- transcribe.py (faster-whisper speech-to-text)
|
||||
+-- install_feature.py (on-demand bundle installer)
|
||||
```
|
||||
|
||||
Отдельный профиль диспетчера «docs» заменяет AI-список разрешённых скриптов на скрипты обработки документов (`doc_pagecount`, `doc_health`, `doc_flatten`, `doc_redact`, `doc_text`, `doc_to_word`, `doc_metadata`, `doc_html_pdf`) и пропускает тяжёлые ML-импорты.
|
||||
|
||||
**Таймауты:** 300 с по умолчанию; для OCR и удаления фона BiRefNet отводится 600 с.
|
||||
|
||||
## Пакеты возможностей {#feature-bundles}
|
||||
|
||||
AI-модели упакованы по общему стеку зависимостей, а не по одному архиву на инструмент. Один пакет возможностей может включать несколько инструментов, если они используют одно семейство моделей, одни Python-колёса (wheels) или одни нативные библиотеки. Это позволяет держать релизный Docker-образ меньше и избегать хранения дубликатов одних и тех же моделей матирования фона, распознавания лиц, OCR, реставрации и речи.
|
||||
|
||||
Docker-образ поставляется вместе с приложением и общей средой выполнения. Крупные архивы моделей загружаются по требованию в постоянный том `/data/ai`, а затем повторно используются каждым инструментом, которому они нужны. Если пакет уже установлен, потому что его затребовал другой инструмент, включение нового зависимого инструмента не приводит к повторной загрузке этого пакета.
|
||||
|
||||
Каждому AI-инструменту требуется один или несколько пакетов возможностей, прежде чем он сможет работать. Админ-интерфейс устанавливает пакеты по инструменту через `POST /api/v1/admin/tools/:toolId/features/install`, который определяет полный список пакетов, пропускает уже установленные и ставит в очередь только недостающие загрузки. Например, включение «Фото на паспорт» на новом экземпляре ставит в очередь `background-removal` и `face-detection`; включение того же инструмента после того, как уже установлено «Удаление фона», ставит в очередь только `face-detection`.
|
||||
|
||||
| Пакет | Размер | Общая группа зависимостей | Инструменты, использующие его |
|
||||
|--------|------|-------------------------|-------------------|
|
||||
| `background-removal` | 4-5 GB | матирование фона rembg / BiRefNet | remove-background, passport-photo, transparency-fixer, background-replace, blur-background |
|
||||
| `face-detection` | 200-300 MB | распознавание лиц и ключевых точек MediaPipe | blur-faces, red-eye-removal, smart-crop |
|
||||
| `object-eraser-colorize` | 1-2 GB | инпейнтинг/аутпейнтинг LaMa и DDColor | erase-object, colorize, ai-canvas-expand |
|
||||
| `upscale-enhance` | 5-6 GB | RealESRGAN, GFPGAN / CodeFormer, шумоподавление | upscale, enhance-faces, noise-removal |
|
||||
| `photo-restoration` | 4-5 GB | конвейер устранения царапин и реставрации | restore-photo |
|
||||
| `ocr` | 5-6 GB | OCR-стек PaddleOCR / Tesseract | ocr, ocr-pdf |
|
||||
| `transcription` | ~600 MB | модели преобразования речи в текст faster-whisper | transcribe-audio, auto-subtitles |
|
||||
|
||||
Инструменты с межпакетными зависимостями:
|
||||
|
||||
| Инструмент | Требуемые пакеты | Причина |
|
||||
|------|------------------|-----|
|
||||
| `passport-photo` | `background-removal`, `face-detection` | Удаляет фон, затем использует ключевые точки лица, чтобы обрезать кадр под правила для фото на паспорт и удостоверение личности. |
|
||||
| `enhance-faces` | `upscale-enhance`, `face-detection` | Распознаёт лица перед применением улучшения GFPGAN или CodeFormer к выбранным областям лица. |
|
||||
|
||||
Инструмент доступен только тогда, когда установлены все его требуемые пакеты. Частичная установка допустима и обрабатывается инкрементально: установленные пакеты используются повторно, недостающие пакеты показываются как загрузки, а поставленные в очередь установки выполняются по одной, чтобы общая среда Python не изменялась одновременно.
|
||||
|
||||
---
|
||||
|
||||
## Удаление фона {#background-removal}
|
||||
|
||||
**Маршрут инструмента:** `remove-background`
|
||||
**Модель:** rembg с BiRefNet (по умолчанию) или варианты U2-Net
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `model` | string | - | Вариант модели (опциональное переопределение) |
|
||||
| `backgroundType` | string | `"transparent"` | Одно из: `transparent`, `color`, `gradient`, `blur`, `image` |
|
||||
| `backgroundColor` | string | - | Hex-цвет для сплошного фона |
|
||||
| `gradientColor1` | string | - | Первый цвет градиента |
|
||||
| `gradientColor2` | string | - | Второй цвет градиента |
|
||||
| `gradientAngle` | number | - | Угол градиента в градусах |
|
||||
| `blurEnabled` | boolean | - | Включить эффект размытия фона |
|
||||
| `blurIntensity` | number (0-100) | - | Интенсивность размытия |
|
||||
| `shadowEnabled` | boolean | - | Включить падающую тень от объекта |
|
||||
| `shadowOpacity` | number (0-100) | - | Непрозрачность тени |
|
||||
| `outputFormat` | string | - | Формат вывода: `png`, `webp` или `avif` |
|
||||
| `edgeRefine` | integer (0-3) | - | Уровень уточнения краёв |
|
||||
| `decontaminate` | boolean | - | Убрать растекание цвета с краёв |
|
||||
|
||||
## Замена фона {#background-replace}
|
||||
|
||||
**Маршрут инструмента:** `background-replace`
|
||||
**Модель:** rembg / BiRefNet (общая с remove-background)
|
||||
|
||||
Удаляет фон и заменяет его сплошным цветом или градиентом.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `backgroundType` | `"color"` \| `"gradient"` | `"color"` | Режим фона |
|
||||
| `color` | string | `"#ffffff"` | Hex-цвет фона (когда `backgroundType` равно `color`) |
|
||||
| `gradientColor1` | string | - | Первый hex-цвет градиента |
|
||||
| `gradientColor2` | string | - | Второй hex-цвет градиента |
|
||||
| `gradientAngle` | integer (0-360) | `180` | Угол градиента в градусах |
|
||||
| `feather` | integer (0-20) | `0` | Радиус растушёвки краёв |
|
||||
| `format` | `"png"` \| `"webp"` | `"png"` | Формат вывода |
|
||||
|
||||
## Размытие фона {#blur-background}
|
||||
|
||||
**Маршрут инструмента:** `blur-background`
|
||||
**Модель:** rembg / BiRefNet (общая с remove-background)
|
||||
|
||||
Размывает фон, сохраняя объект резким.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `intensity` | integer (1-100) | `50` | Интенсивность размытия |
|
||||
| `feather` | integer (0-20) | `0` | Радиус растушёвки краёв |
|
||||
| `format` | `"png"` \| `"webp"` | `"png"` | Формат вывода |
|
||||
|
||||
## Апскейлинг изображений {#image-upscaling}
|
||||
|
||||
**Маршрут инструмента:** `upscale`
|
||||
**Модель:** RealESRGAN (с запасным вариантом Lanczos при недоступности)
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `scale` | number | `2` | Коэффициент увеличения |
|
||||
| `model` | string | `"auto"` | Вариант модели |
|
||||
| `faceEnhance` | boolean | `false` | Применить проход улучшения лиц GFPGAN |
|
||||
| `denoise` | number | `0` | Сила шумоподавления |
|
||||
| `format` | string | `"auto"` | Переопределение формата вывода |
|
||||
| `quality` | number | `95` | Качество вывода (1-100) |
|
||||
|
||||
## OCR / извлечение текста {#ocr-text-extraction}
|
||||
|
||||
**Маршрут инструмента:** `ocr`
|
||||
**Модели:** Tesseract (быстро), PaddleOCR PP-OCRv5 (сбалансированно), PaddleOCR-VL 1.5 (лучшее качество)
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `quality` | `"fast"` \| `"balanced"` \| `"best"` | `"balanced"` | Уровень обработки |
|
||||
| `language` | string | `"auto"` | Язык: `auto`, `en`, `de`, `fr`, `es`, `zh`, `ja`, `ko` |
|
||||
| `enhance` | boolean | `true` | Предобработка изображения для повышения точности OCR |
|
||||
| `engine` | string | - | Устарело. Сопоставляет `tesseract` с `fast`, `paddleocr` с `balanced` |
|
||||
|
||||
Возвращает структурированные результаты с ограничивающими рамками, оценками достоверности и извлечёнными блоками текста.
|
||||
|
||||
## OCR для PDF {#pdf-ocr}
|
||||
|
||||
**Маршрут инструмента:** `ocr-pdf`
|
||||
**Модели:** Та же система уровней, что и у OCR изображений
|
||||
|
||||
Извлекает текст из отсканированных PDF-документов с помощью AI-OCR, страница за страницей.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `quality` | `"fast"` \| `"balanced"` \| `"best"` | `"balanced"` | Уровень обработки |
|
||||
| `language` | string | `"auto"` | Язык: `auto`, `en`, `de`, `fr`, `es`, `zh`, `ja`, `ko` |
|
||||
| `pages` | string | `"all"` | Выбор страниц: `"all"`, `"1-3"`, `"1,3,5"` |
|
||||
|
||||
## Размытие лиц / персональных данных {#face-pii-blur}
|
||||
|
||||
**Маршрут инструмента:** `blur-faces`
|
||||
**Модель:** распознавание лиц MediaPipe
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `blurRadius` | number (1-100) | `30` | Радиус гауссова размытия |
|
||||
| `sensitivity` | number (0-1) | `0.5` | Порог достоверности распознавания |
|
||||
|
||||
## Улучшение лиц {#face-enhancement}
|
||||
|
||||
**Маршрут инструмента:** `enhance-faces`
|
||||
**Модели:** GFPGAN, CodeFormer
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `model` | `"auto"` \| `"gfpgan"` \| `"codeformer"` | `"auto"` | Модель улучшения |
|
||||
| `strength` | number (0-1) | `0.8` | Сила улучшения |
|
||||
| `sensitivity` | number (0-1) | `0.5` | Порог распознавания лиц |
|
||||
| `onlyCenterFace` | boolean | `false` | Улучшать только самое центральное лицо |
|
||||
|
||||
## AI-раскрашивание {#ai-colorization}
|
||||
|
||||
**Маршрут инструмента:** `colorize`
|
||||
**Модель:** DDColor (с запасным вариантом OpenCV DNN)
|
||||
|
||||
Преобразует чёрно-белые или полутоновые фотографии в полноцветные.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `intensity` | number (0-1) | `1.0` | Сила насыщенности цвета |
|
||||
| `model` | `"auto"` \| `"ddcolor"` \| `"opencv"` | `"auto"` | Вариант модели |
|
||||
|
||||
## Удаление шума {#noise-removal}
|
||||
|
||||
**Маршрут инструмента:** `noise-removal`
|
||||
**Модель:** SCUNet (многоуровневый конвейер шумоподавления)
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `tier` | `"quick"` \| `"balanced"` \| `"quality"` \| `"maximum"` | `"balanced"` | Уровень обработки |
|
||||
| `strength` | number (0-100) | `50` | Сила шумоподавления |
|
||||
| `detailPreservation` | number (0-100) | `50` | Сколько деталей сохранять; выше значение сохраняет больше текстуры |
|
||||
| `colorNoise` | number (0-100) | `30` | Сила подавления цветового шума |
|
||||
| `format` | string | `"original"` | Формат вывода: `original`, `png`, `jpeg`, `webp`, `avif`, `jxl` |
|
||||
| `quality` | number (1-100) | `90` | Качество кодирования вывода |
|
||||
|
||||
## Удаление эффекта красных глаз {#red-eye-removal}
|
||||
|
||||
**Маршрут инструмента:** `red-eye-removal`
|
||||
|
||||
Распознаёт ключевые точки лица, находит области глаз и корректирует перенасыщенность красного канала.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `sensitivity` | number (0-100) | `50` | Порог обнаружения красных пикселей |
|
||||
| `strength` | number (0-100) | `70` | Сила коррекции |
|
||||
| `format` | string | - | Переопределение формата вывода (опционально) |
|
||||
| `quality` | number (1-100) | `90` | Качество вывода |
|
||||
|
||||
## Реставрация фотографий {#photo-restoration}
|
||||
|
||||
**Маршрут инструмента:** `restore-photo`
|
||||
|
||||
Многошаговый конвейер для старых или повреждённых фотографий: обнаружение и устранение царапин/разрывов, улучшение лиц, шумоподавление и опциональное раскрашивание.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `scratchRemoval` | boolean | `true` | Обнаруживать и устранять царапины, разрывы |
|
||||
| `faceEnhancement` | boolean | `true` | Применить проход улучшения лиц |
|
||||
| `fidelity` | number (0-1) | `0.7` | Сила улучшения лиц (выше = более консервативно) |
|
||||
| `denoise` | boolean | `true` | Применить проход шумоподавления |
|
||||
| `denoiseStrength` | number (0-100) | `25` | Сила шумоподавления |
|
||||
| `colorize` | boolean | `false` | Раскрасить после реставрации |
|
||||
| `colorizeStrength` | number (0-100) | `85` | Интенсивность раскрашивания |
|
||||
|
||||
## Фото на паспорт {#passport-photo}
|
||||
|
||||
**Маршрут инструмента:** `passport-photo`
|
||||
**Модели:** ключевые точки лица MediaPipe + удаление фона BiRefNet
|
||||
|
||||
Двухфазный рабочий процесс: анализ (распознать лицо + удалить фон), затем генерация (обрезка, изменение размера, замощение). Поддерживает 37+ стран в 6 регионах.
|
||||
|
||||
### Фаза 1: анализ {#phase-1-analyze}
|
||||
|
||||
`POST /api/v1/tools/image/passport-photo/analyze`
|
||||
|
||||
Принимает файл изображения (multipart). Возвращает данные ключевых точек лица, base64-превью и размеры изображения.
|
||||
|
||||
### Фаза 2: генерация {#phase-2-generate}
|
||||
|
||||
`POST /api/v1/tools/image/passport-photo/generate`
|
||||
|
||||
Принимает JSON-тело с результатами фазы 1 плюс настройки генерации:
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `jobId` | string | (обязательно) | Идентификатор задания из фазы 1 |
|
||||
| `filename` | string | (обязательно) | Исходное имя файла из фазы 1 |
|
||||
| `countryCode` | string | (обязательно) | ISO-код страны (например, `US`, `GB`, `IN`) |
|
||||
| `documentType` | string | `"passport"` | Тип документа |
|
||||
| `bgColor` | string | `"#FFFFFF"` | Hex-цвет фона |
|
||||
| `printLayout` | string | `"none"` | Макет печати: `none`, `4x6`, `a4`, `letter` |
|
||||
| `maxFileSizeKb` | number | `0` | Максимальный размер файла в KB (0 = без ограничения) |
|
||||
| `dpi` | number (72-1200) | `300` | DPI вывода |
|
||||
| `customWidthMm` | number | - | Пользовательская ширина в мм (переопределяет спецификацию страны) |
|
||||
| `customHeightMm` | number | - | Пользовательская высота в мм (переопределяет спецификацию страны) |
|
||||
| `zoom` | number (0.5-3) | `1` | Коэффициент масштабирования |
|
||||
| `adjustX` | number | `0` | Регулировка горизонтального положения |
|
||||
| `adjustY` | number | `0` | Регулировка вертикального положения |
|
||||
| `landmarks` | object | (обязательно) | Ключевые точки из фазы 1 |
|
||||
| `imageWidth` | number | (обязательно) | Ширина изображения из фазы 1 |
|
||||
| `imageHeight` | number | (обязательно) | Высота изображения из фазы 1 |
|
||||
|
||||
## Удаление объектов (инпейнтинг) {#object-erasing-inpainting}
|
||||
|
||||
**Маршрут инструмента:** `erase-object`
|
||||
**Модель:** LaMa через ONNX Runtime
|
||||
|
||||
Маска отправляется как **вторая файловая часть** (имя поля `mask`), а не как base64. Белые пиксели в маске обозначают области для удаления. Настройки `format` и `quality` отправляются как поля формы верхнего уровня.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `file` | file | (обязательно) | Исходное изображение (multipart) |
|
||||
| `mask` | file | (обязательно) | Изображение маски (multipart, имя поля `mask`, белое = удалить) |
|
||||
| `format` | string | `"auto"` | Формат вывода: `auto`, `png`, `jpg`, `jpeg`, `webp`, `tiff`, `gif`, `avif`, `heic`, `heif`, `jxl` |
|
||||
| `quality` | integer (1-100) | `95` | Качество вывода |
|
||||
|
||||
Ускоряется через CUDA при наличии NVIDIA GPU.
|
||||
|
||||
## AI-расширение холста {#ai-canvas-expand}
|
||||
|
||||
**Маршрут инструмента:** `ai-canvas-expand`
|
||||
**Модель:** аутпейнтинг на базе LaMa
|
||||
|
||||
Расширяет холст изображения в любом направлении и заполняет новые области сгенерированным AI-содержимым, совпадающим с существующим изображением.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `extendTop` | integer | `0` | Пикселей для расширения сверху |
|
||||
| `extendRight` | integer | `0` | Пикселей для расширения справа |
|
||||
| `extendBottom` | integer | `0` | Пикселей для расширения снизу |
|
||||
| `extendLeft` | integer | `0` | Пикселей для расширения слева |
|
||||
| `tier` | `"fast"` \| `"balanced"` \| `"high"` | `"balanced"` | Уровень качества |
|
||||
| `format` | string | `"auto"` | Формат вывода: `auto`, `png`, `jpg`, `jpeg`, `webp`, `tiff`, `gif`, `avif`, `heic`, `heif`, `jxl` |
|
||||
| `quality` | integer (1-100) | `95` | Качество вывода |
|
||||
|
||||
Хотя бы одно направление расширения должно быть больше 0.
|
||||
|
||||
## Умная обрезка {#smart-crop}
|
||||
|
||||
**Маршрут инструмента:** `smart-crop`
|
||||
**Модель:** распознавание лиц MediaPipe (только режим лиц)
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `mode` | string | `"subject"` | Стратегия обрезки: `subject`, `face`, `trim` |
|
||||
| `strategy` | `"attention"` \| `"entropy"` | `"attention"` | Стратегия для режима объекта |
|
||||
| `width` | integer | - | Ширина вывода |
|
||||
| `height` | integer | - | Высота вывода |
|
||||
| `padding` | integer (0-50) | `0` | Процент отступа вокруг объекта |
|
||||
| `facePreset` | string | `"head-shoulders"` | Предустановка кадрирования, когда `mode=face` |
|
||||
| `sensitivity` | number (0-1) | `0.5` | Порог распознавания лиц |
|
||||
| `threshold` | integer (0-255) | `30` | Порог определения фона (режим обрезки) |
|
||||
| `padToSquare` | boolean | `false` | Дополнить обрезанный результат до квадрата |
|
||||
| `padColor` | string | `"#ffffff"` | Цвет фона для квадратного дополнения |
|
||||
| `targetSize` | integer | - | Целевой размер для дополненного вывода (пиксели) |
|
||||
| `quality` | integer (1-100) | - | Качество вывода |
|
||||
|
||||
Устаревшие значения `mode` `attention` и `content` принимаются и сопоставляются с `subject` и `trim` соответственно.
|
||||
|
||||
**Предустановки для лиц:**
|
||||
|
||||
| Предустановка | Лучше всего для |
|
||||
|--------|---------|
|
||||
| `closeup` | Портретные фото |
|
||||
| `head-shoulders` | Фото профиля |
|
||||
| `upper-body` | LinkedIn / официальные |
|
||||
| `half-body` | Вся верхняя часть тела |
|
||||
|
||||
## Транскрибирование аудио {#transcribe-audio}
|
||||
|
||||
**Маршрут инструмента:** `transcribe-audio`
|
||||
**Модель:** faster-whisper
|
||||
|
||||
Преобразует речь в текст. Поддерживает вывод в форматах простого текста, SRT и VTT.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `language` | string | `"auto"` | Язык: `auto`, `en`, `de`, `fr`, `es`, `zh`, `ja`, `ko`, `id`, `th`, `vi` |
|
||||
| `outputFormat` | `"txt"` \| `"srt"` \| `"vtt"` | `"txt"` | Формат вывода |
|
||||
|
||||
## Автоматические субтитры {#auto-subtitles}
|
||||
|
||||
**Маршрут инструмента:** `auto-subtitles`
|
||||
**Модель:** faster-whisper (извлекает аудио из видео, затем транскрибирует)
|
||||
|
||||
Генерирует файлы субтитров из звуковой дорожки видео.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `language` | string | `"auto"` | Язык: `auto`, `en`, `de`, `fr`, `es`, `zh`, `ja`, `ko`, `id`, `th`, `vi` |
|
||||
| `format` | `"srt"` \| `"vtt"` | `"srt"` | Формат вывода субтитров |
|
||||
|
||||
## Исправление прозрачности PNG {#png-transparency-fixer}
|
||||
|
||||
**Маршрут инструмента:** `transparency-fixer`
|
||||
**Модель:** BiRefNet HR-matting (разрешение 2048x2048)
|
||||
|
||||
Исправляет «псевдопрозрачные» PNG, где фон был удалён, но остались бахрома, ореолы или полупрозрачные артефакты. Использует высокоразрешающую модель матирования BiRefNet для создания чистого альфа-канала, затем применяет настраиваемую обработку удаления бахромы для устранения цветового загрязнения вдоль краёв.
|
||||
|
||||
**Цепочка запасных вариантов при нехватке памяти (OOM):** Если BiRefNet HR-matting превышает доступную память, инструмент автоматически переходит на `birefnet-general`, затем на `u2net`.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `defringe` | number (0-100) | `30` | Сила удаления бахромы по краям для устранения цветового загрязнения |
|
||||
| `outputFormat` | `"png"` \| `"webp"` | `"png"` | Формат выходного изображения |
|
||||
| `removeWatermark` | boolean | `false` | Применить предобработку удаления водяных знаков (медианный фильтр) |
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/image/transparency-fixer \
|
||||
-H "Authorization: Bearer <token>" \
|
||||
-F "file=@fake-transparent.png" \
|
||||
-F 'settings={"defringe":30,"outputFormat":"png"}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Инструменты с опциональными AI-возможностями {#tools-with-optional-ai-capabilities}
|
||||
|
||||
Следующие инструменты не являются инструментами Python-сайдкара, но используют AI-возможности, когда включены определённые опции.
|
||||
|
||||
### Улучшение изображений {#image-enhancement}
|
||||
|
||||
**Маршрут инструмента:** `image-enhancement`
|
||||
**Движок:** на основе анализа (гистограмма и статистика Sharp)
|
||||
|
||||
Анализирует изображение и применяет автоматические коррекции экспозиции, контраста, баланса белого, насыщенности, резкости и шума. Поддерживает режимы под конкретные сцены.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `mode` | `"auto"` \| `"portrait"` \| `"landscape"` \| `"low-light"` \| `"food"` \| `"document"` | `"auto"` | Режим сцены для настройки коррекций |
|
||||
| `intensity` | number (0-100) | `50` | Общая сила коррекции |
|
||||
| `corrections.exposure` | boolean | `true` | Применить коррекцию экспозиции |
|
||||
| `corrections.contrast` | boolean | `true` | Применить коррекцию контраста |
|
||||
| `corrections.whiteBalance` | boolean | `true` | Применить коррекцию баланса белого |
|
||||
| `corrections.saturation` | boolean | `true` | Применить коррекцию насыщенности |
|
||||
| `corrections.sharpness` | boolean | `true` | Применить коррекцию резкости |
|
||||
| `corrections.denoise` | boolean | `true` | Применить шумоподавление |
|
||||
| `deepEnhance` | boolean | `false` | Включить AI-удаление шума через SCUNet (требует пакет `upscale-enhance`) |
|
||||
|
||||
Дополнительная конечная точка анализа доступна по адресу `POST /api/v1/tools/image/image-enhancement/analyze`, которая возвращает обнаруженные коррекции без их применения.
|
||||
|
||||
### Контентно-зависимое изменение размера (Seam Carving) {#content-aware-resize-seam-carving}
|
||||
|
||||
**Маршрут инструмента:** `content-aware-resize`
|
||||
**Движок:** бинарник Go `caire` (не Python, без выгоды от GPU)
|
||||
|
||||
Интеллектуально изменяет размер изображений, удаляя низкоэнергетические швы и сохраняя важное содержимое.
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `width` | number | - | Целевая ширина |
|
||||
| `height` | number | - | Целевая высота |
|
||||
| `protectFaces` | boolean | `false` | Защищать обнаруженные области лиц (требует пакет `face-detection`) |
|
||||
| `blurRadius` | number (0-20) | `4` | Предварительное размытие для расчёта энергии |
|
||||
| `sobelThreshold` | number (1-20) | `2` | Порог чувствительности к краям |
|
||||
| `square` | boolean | `false` | Принудительный квадратный вывод |
|
||||
@@ -0,0 +1,211 @@
|
||||
---
|
||||
description: "Справочник по операциям движка изображений. Все операции обработки изображений на базе Sharp и их параметры."
|
||||
i18n_source_hash: 42febdf85fa8
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: b6b18f196fbd
|
||||
---
|
||||
|
||||
# Движок изображений {#image-engine}
|
||||
|
||||
Пакет `@snapotter/image-engine` обрабатывает все не-AI операции с изображениями. Он оборачивает [Sharp](https://sharp.pixelplumbing.com/) и работает полностью внутри процесса без внешних зависимостей.
|
||||
|
||||
## Операции {#operations}
|
||||
|
||||
### resize {#resize}
|
||||
|
||||
Масштабирование изображения до конкретных размеров или в процентах.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `width` | number | Целевая ширина в пикселях |
|
||||
| `height` | number | Целевая высота в пикселях |
|
||||
| `fit` | string | `cover`, `contain`, `fill`, `inside` или `outside` |
|
||||
| `withoutEnlargement` | boolean | Если true, не увеличивает меньшие изображения |
|
||||
| `percentage` | number | Масштабировать в процентах вместо абсолютных размеров |
|
||||
|
||||
Можно задать `width`, `height` или оба. Если задать только один, другой вычисляется для сохранения соотношения сторон.
|
||||
|
||||
### crop {#crop}
|
||||
|
||||
Вырезание прямоугольной области из изображения.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `left` | number | Смещение X от левого края |
|
||||
| `top` | number | Смещение Y от верхнего края |
|
||||
| `width` | number | Ширина области обрезки |
|
||||
| `height` | number | Высота области обрезки |
|
||||
| `unit` | string | `px` (по умолчанию) или `percent` |
|
||||
|
||||
### rotate {#rotate}
|
||||
|
||||
Поворот изображения на заданный угол.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `angle` | number | Угол поворота в градусах (0-360) |
|
||||
| `background` | string | Цвет заливки открывшейся области (по умолчанию: `#000000`). Применяется только к углам, не кратным 90 градусам. |
|
||||
|
||||
### flip {#flip}
|
||||
|
||||
Отражение изображения по горизонтали, вертикали или обоим осям. Хотя бы одно значение должно быть true.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `horizontal` | boolean | Отразить слева направо |
|
||||
| `vertical` | boolean | Отразить сверху вниз |
|
||||
|
||||
### convert {#convert}
|
||||
|
||||
Изменение формата изображения.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `format` | string | Целевой формат: `jpg`, `png`, `webp`, `avif`, `tiff`, `gif`, `jxl`, `heic`, `heif`, `bmp`, `ico`, `jp2`, `qoi` |
|
||||
| `quality` | number | Качество сжатия (1-100, применяется к форматам с потерями) |
|
||||
|
||||
Первые семь форматов (от `jpg` до `jxl`) кодируются Sharp внутри процесса. Остальные форматы используют внешние кодеры на уровне API: `heic`/`heif` через heif-enc, `bmp`/`ico` через ImageMagick, `jp2` через opj_compress и `qoi` через встроенный TypeScript-кодек.
|
||||
|
||||
### compress {#compress}
|
||||
|
||||
Уменьшение размера файла с сохранением того же формата.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `quality` | number | Целевое качество (1-100) |
|
||||
| `targetSizeBytes` | number | Опциональный целевой размер файла в байтах |
|
||||
| `format` | string | Опциональное переопределение формата |
|
||||
|
||||
### strip-metadata {#strip-metadata}
|
||||
|
||||
Удаление метаданных EXIF, IPTC, XMP и ICC из изображения. Без параметров (или с `stripAll: true`) удаляет всё. Передайте отдельные флаги для выборочного удаления.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `stripAll` | boolean | Удалить все метаданные (по умолчанию, если флаги не заданы) |
|
||||
| `stripExif` | boolean | Удалить данные EXIF (включая GPS, если `stripGps` не задан отдельно) |
|
||||
| `stripGps` | boolean | Удалить данные о GPS-местоположении |
|
||||
| `stripIcc` | boolean | Удалить цветовой профиль ICC |
|
||||
| `stripXmp` | boolean | Удалить метаданные XMP |
|
||||
|
||||
### Настройки цвета {#color-adjustments}
|
||||
|
||||
Эти операции изменяют цветовые свойства изображения. Каждая принимает одно числовое значение.
|
||||
|
||||
| Операция | Параметр | Диапазон | Описание |
|
||||
|---|---|---|---|
|
||||
| `brightness` | `value` | -100 до 100 | Настройка яркости |
|
||||
| `contrast` | `value` | -100 до 100 | Настройка контрастности |
|
||||
| `saturation` | `value` | -100 до 100 | Настройка насыщенности цвета |
|
||||
|
||||
### Цветовые фильтры {#color-filters}
|
||||
|
||||
Применяют фиксированное цветовое преобразование. Не принимают параметров.
|
||||
|
||||
| Операция | Описание |
|
||||
|---|---|
|
||||
| `grayscale` | Преобразовать в оттенки серого |
|
||||
| `sepia` | Применить тон сепии |
|
||||
| `invert` | Инвертировать все цвета |
|
||||
|
||||
### Цветовые каналы {#color-channels}
|
||||
|
||||
Настройка отдельных цветовых каналов RGB. Значения являются множителями, где 100 = без изменений.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `red` | number | Множитель красного канала (0 до 200, 100 = без изменений) |
|
||||
| `green` | number | Множитель зелёного канала (0 до 200, 100 = без изменений) |
|
||||
| `blue` | number | Множитель синего канала (0 до 200, 100 = без изменений) |
|
||||
|
||||
### sharpen {#sharpen}
|
||||
|
||||
Простое повышение резкости, управляемое одним значением.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `value` | number | Интенсивность резкости (0 до 100). Сопоставляется с гауссовой сигмой 0.5-10. |
|
||||
|
||||
### sharpen-advanced {#sharpen-advanced}
|
||||
|
||||
Продвинутое повышение резкости с тремя выбираемыми методами и опциональным предварительным проходом шумоподавления.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `method` | string | `adaptive`, `unsharp-mask` или `high-pass` |
|
||||
| `sigma` | number | Радиус гауссова размытия, 0.5-10 (адаптивный) |
|
||||
| `m1` | number | Резкость плоских областей, 0-10 (адаптивный) |
|
||||
| `m2` | number | Резкость текстурированных областей, 0-20 (адаптивный) |
|
||||
| `x1` | number | Порог плоское/зубчатое, 0-10 (адаптивный) |
|
||||
| `y2` | number | Максимальное осветление (ограничение ореола), 0-50 (адаптивный) |
|
||||
| `y3` | number | Максимальное затемнение (ограничение ореола), 0-50 (адаптивный) |
|
||||
| `amount` | number | Процент интенсивности, 0-500 (нерезкая маска) |
|
||||
| `radius` | number | Радиус размытия, 0.1-5.0 (нерезкая маска) |
|
||||
| `threshold` | number | Минимальная яркость края, 0-255 (нерезкая маска) |
|
||||
| `strength` | number | Сила смешивания, 0-100 (высокочастотный) |
|
||||
| `kernelSize` | number | `3` или `5` для ядра 3x3 / 5x5 (высокочастотный) |
|
||||
| `denoise` | string | Предварительный проход шумоподавления: `off`, `light`, `medium` или `strong` |
|
||||
|
||||
Параметры специфичны для метода. Указывайте только те, что относятся к выбранному методу.
|
||||
|
||||
### color-blindness {#color-blindness}
|
||||
|
||||
Симуляция дефицита цветового зрения с помощью матрицы цветовой рекомбинации 3x3.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `type` | string | Одно из: `protanopia`, `deuteranopia`, `tritanopia`, `protanomaly`, `deuteranomaly`, `tritanomaly`, `achromatopsia`, `blueConeMonochromacy` |
|
||||
|
||||
### edit-metadata {#edit-metadata}
|
||||
|
||||
Запись или удаление отдельных полей метаданных EXIF/IPTC без удаления всего блока.
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
|---|---|---|
|
||||
| `artist` | string | Тег EXIF Artist |
|
||||
| `copyright` | string | Тег EXIF Copyright |
|
||||
| `imageDescription` | string | Тег EXIF ImageDescription |
|
||||
| `software` | string | Тег EXIF Software |
|
||||
| `dateTime` | string | Тег EXIF DateTime |
|
||||
| `dateTimeOriginal` | string | Тег EXIF DateTimeOriginal |
|
||||
| `clearGps` | boolean | Удалить все теги GPS |
|
||||
| `fieldsToRemove` | string[] | Список имён полей EXIF для удаления |
|
||||
|
||||
Все параметры опциональны. Поля, перечисленные в `fieldsToRemove`, удаляются из существующего блока EXIF. Поля, заданные через именованные параметры, записываются (или перезаписываются). Двоичные/небезопасные ключи, такие как MakerNote, молча игнорируются.
|
||||
|
||||
## Определение формата {#format-detection}
|
||||
|
||||
Движок определяет входные форматы автоматически по заголовкам файлов, а не только по расширениям. Это значит, что файл `.jpg`, который на самом деле является PNG, будет обработан корректно. Определение использует многослойный подход: сначала магические байты, затем расширение файла как запасной вариант.
|
||||
|
||||
SnapOtter поддерживает **55+ входных форматов** и **13 выходных форматов**, включая 23 формата RAW камер от 20+ брендов, профессиональные форматы (PSD, EPS, OpenEXR, HDR), современные кодеки (JPEG XL, AVIF, HEIC, QOI, JPEG 2000) и научные/игровые форматы (FITS, DDS). Декодирование выполняется нативно через Sharp там, где это возможно, с автоматическим откатом на ImageMagick, LibRaw и специализированные CLI-декодеры.
|
||||
|
||||
См. страницу [Поддерживаемые форматы](/ru/guide/supported-formats) для полного списка.
|
||||
|
||||
## Извлечение метаданных {#metadata-extraction}
|
||||
|
||||
Инструмент `info` возвращает метаданные изображения. См. [Информация об изображении](/ru/tools/image/info) для полного справочника полей.
|
||||
|
||||
```json
|
||||
{
|
||||
"filename": "photo.jpg",
|
||||
"fileSize": 2450000,
|
||||
"width": 4032,
|
||||
"height": 3024,
|
||||
"format": "jpeg",
|
||||
"channels": 3,
|
||||
"hasAlpha": false,
|
||||
"colorSpace": "srgb",
|
||||
"density": 72,
|
||||
"isProgressive": false,
|
||||
"hasExif": true,
|
||||
"hasIcc": true,
|
||||
"hasXmp": false,
|
||||
"bitDepth": "8",
|
||||
"pages": 1,
|
||||
"histogram": [
|
||||
{ "channel": "red", "min": 0, "max": 255, "mean": 128.45, "stdev": 52.31 },
|
||||
{ "channel": "green", "min": 2, "max": 253, "mean": 115.22, "stdev": 48.76 },
|
||||
{ "channel": "blue", "min": 0, "max": 250, "mean": 102.89, "stdev": 55.14 }
|
||||
]
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,702 @@
|
||||
---
|
||||
description: "Полный справочник REST API. Эндпоинты инструментов, пакетная обработка, конвейеры, файловая библиотека, аутентификация, команды и административные операции."
|
||||
i18n_source_hash: 8646977f7cc9
|
||||
i18n_provenance: machine
|
||||
i18n_output_hash: b2ec4e36cb9f
|
||||
---
|
||||
|
||||
# Справочник REST API {#rest-api-reference}
|
||||
|
||||
Интерактивная документация API с примерами запросов и ответов доступна по адресу [http://localhost:1349/api/docs](http://localhost:1349/api/docs).
|
||||
|
||||
Машиночитаемые спецификации:
|
||||
- `/api/v1/openapi.yaml` - спецификация OpenAPI 3.1
|
||||
- `/llms.txt` - удобная для LLM сводка
|
||||
- `/llms-full.txt` - полная удобная для LLM документация
|
||||
|
||||
## Аутентификация {#authentication}
|
||||
|
||||
Все эндпоинты требуют аутентификации, если `AUTH_ENABLED=false`.
|
||||
|
||||
### Токен сессии {#session-token}
|
||||
|
||||
```bash
|
||||
# Login
|
||||
curl -X POST http://localhost:1349/api/auth/login \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"username":"admin","password":"admin"}'
|
||||
# Returns: {"token":"<session-token>"}
|
||||
|
||||
# Use token
|
||||
curl http://localhost:1349/api/v1/tools/image/resize \
|
||||
-H "Authorization: Bearer <session-token>"
|
||||
```
|
||||
|
||||
Сессии истекают через 7 дней (настраивается через `SESSION_DURATION_HOURS`).
|
||||
|
||||
### API-ключи {#api-keys}
|
||||
|
||||
```bash
|
||||
# Create a key (returns key once - store it)
|
||||
curl -X POST http://localhost:1349/api/v1/api-keys \
|
||||
-H "Authorization: Bearer <session-token>" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"name":"my-script"}'
|
||||
# Returns: {"key":"si_<96 hex chars>","id":"...","name":"my-script"}
|
||||
|
||||
# Use the key
|
||||
curl http://localhost:1349/api/v1/tools/image/resize \
|
||||
-H "Authorization: Bearer si_<your-key>"
|
||||
```
|
||||
|
||||
Ключи имеют префикс `si_` и хранятся как scrypt-хеши: необработанный ключ показывается один раз и после этого получить его повторно невозможно.
|
||||
|
||||
### Эндпоинты аутентификации {#auth-endpoints}
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `POST` | `/api/auth/login` | Публичный | Вход, получение токена сессии |
|
||||
| `POST` | `/api/auth/logout` | Auth | Уничтожение текущей сессии |
|
||||
| `GET` | `/api/auth/session` | Auth | Проверка текущей сессии |
|
||||
| `POST` | `/api/auth/change-password` | Auth | Смена собственного пароля (аннулирует все остальные сессии и API-ключи) |
|
||||
| `GET` | `/api/auth/users` | Admin | Список всех пользователей |
|
||||
| `POST` | `/api/auth/register` | Admin | Создание нового пользователя |
|
||||
| `PUT` | `/api/auth/users/:id` | Admin | Обновление роли или команды пользователя |
|
||||
| `POST` | `/api/auth/users/:id/reset-password` | Admin | Сброс пароля пользователя |
|
||||
| `DELETE` | `/api/auth/users/:id` | Admin | Удаление пользователя |
|
||||
| `GET` | `/api/v1/config/auth` | Публичный | Проверка, включена ли аутентификация (`{ authEnabled: bool }`) |
|
||||
| `POST` | `/api/auth/mfa/enroll` | Auth | Начало регистрации TOTP MFA. Требует enterprise-функцию `mfa` |
|
||||
| `POST` | `/api/auth/mfa/verify` | Auth | Подтверждение регистрации MFA кодом TOTP |
|
||||
| `POST` | `/api/auth/mfa/complete` | Публичный | Завершение ожидающего запроса на вход через MFA |
|
||||
| `POST` | `/api/auth/mfa/disable` | Auth | Отключение MFA для текущего пользователя |
|
||||
| `POST` | `/api/auth/users/:id/mfa/reset` | Admin (`users:manage`) | Сброс MFA для пользователя |
|
||||
| `GET` | `/api/auth/oidc/login` | Публичный | Начало входа через OIDC, когда OIDC включён |
|
||||
| `GET` | `/api/auth/oidc/callback` | Публичный | Callback авторизации OIDC |
|
||||
| `GET` | `/api/auth/saml/metadata` | Публичный | XML-метаданные SAML SP, когда SAML включён |
|
||||
| `GET` | `/api/auth/saml/login` | Публичный | Начало входа через SAML |
|
||||
| `POST` | `/api/auth/saml/callback` | Публичный | Служба потребителя утверждений SAML |
|
||||
|
||||
Когда для пользователя включён MFA, `POST /api/auth/login` возвращает `{"requiresMfa":true,"mfaToken":"...","mfaRequired":true|false}` вместо токена сессии. Отправьте этот `mfaToken` вместе с кодом TOTP или кодом восстановления на `/api/auth/mfa/complete`.
|
||||
|
||||
### Разрешения {#permissions}
|
||||
|
||||
| Разрешение | Admin | User |
|
||||
|-----------|:-----:|:----:|
|
||||
| Использование инструментов | ✓ | ✓ |
|
||||
| Собственные файлы/конвейеры/API-ключи | ✓ | ✓ |
|
||||
| Просмотр файлов/конвейеров/ключей всех пользователей | ✓ | - |
|
||||
| Запись настроек | ✓ | - |
|
||||
| Управление пользователями и командами | ✓ | - |
|
||||
| Управление брендингом | ✓ | - |
|
||||
|
||||
## Проверка состояния {#health-check}
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/health` | Публичный | Базовая проверка состояния. Возвращает `{"status":"healthy","version":"..."}` с кодом 200 или `{"status":"unhealthy"}` с кодом 503, если база данных недоступна. |
|
||||
| `GET` | `/api/v1/readyz` | Публичный | Проба готовности. Проверяет PostgreSQL, Redis, дисковое пространство и S3, если он настроен. Возвращает 503, когда экземпляр не должен принимать трафик. |
|
||||
| `GET` | `/api/v1/admin/health` | Admin (`system:health`) | Подробная диагностика, включая время работы, режим хранилища, состояние базы данных, состояние очереди и доступность GPU. |
|
||||
|
||||
## Использование инструментов {#using-tools}
|
||||
|
||||
Каждый инструмент следует одному и тому же шаблону:
|
||||
|
||||
```bash
|
||||
# Single file
|
||||
curl -X POST http://localhost:1349/api/v1/tools/<section>/<toolId> \
|
||||
-H "Authorization: Bearer <token>" \
|
||||
-F "file=@input.jpg" \
|
||||
-F 'settings={"width":800,"height":600}'
|
||||
|
||||
# Batch (returns ZIP)
|
||||
curl -X POST http://localhost:1349/api/v1/tools/<section>/<toolId>/batch \
|
||||
-H "Authorization: Bearer <token>" \
|
||||
-F "files=@a.jpg" \
|
||||
-F "files=@b.jpg" \
|
||||
-F 'settings={...}'
|
||||
```
|
||||
|
||||
`<section>` - это одно из `image`, `video`, `audio`, `pdf` или `files`.
|
||||
|
||||
- Загрузка - это `multipart/form-data`.
|
||||
- `settings` - это JSON-строка с опциями конкретного инструмента.
|
||||
- `clientJobId` - необязательное поле формы для корреляции прогресса, задаваемой вызывающей стороной.
|
||||
- `fileId` - необязательное поле формы, ссылающееся на существующий элемент файловой библиотеки. Если оно присутствует, обработанный результат сохраняется как новая версия, и ответ включает `savedFileId`.
|
||||
- **Быстрые инструменты** обычно возвращают JSON с кодом 200: `{"jobId":"...","downloadUrl":"/api/v1/download/<jobId>/<filename>","originalSize":1234,"processedSize":567}`. Получите обработанный файл из `downloadUrl`.
|
||||
- **Любой поставленный в очередь инструмент** может вернуть JSON с кодом 202, если он долго выполняется или превышает окно синхронного ожидания: `{"jobId":"...","async":true}`. Подключитесь к SSE для отслеживания прогресса, затем загрузите результат по завершении (см. [Отслеживание прогресса](#progress-tracking)).
|
||||
- **Пакетные** маршруты возвращают ZIP-архив, передаваемый напрямую (с заголовком `X-Job-Id`), для инструментов, зарегистрированных в общем пакетном реестре.
|
||||
|
||||
## Справочник инструментов {#tools-reference}
|
||||
|
||||
### Пресеты конвертации {#conversion-presets}
|
||||
|
||||
Общий каталог включает 83 специальных эндпоинта пресетов конвертации, таких как `jpg-to-png`, `mov-to-mp4`, `m4a-to-mp3`, `pdf-to-jpg` и `excel-to-csv`. Пресеты - это полноценные маршруты инструментов:
|
||||
|
||||
`POST /api/v1/tools/<section>/<presetId>`
|
||||
|
||||
Каждый пресет фиксирует выходной формат и делегирует базовому инструменту, такому как `convert`, `convert-video`, `extract-audio`, `convert-audio`, `image-to-pdf`, `pdf-to-image`, `svg-to-raster` или `convert-spreadsheet`. Полную таблицу маршрутов и необязательные настройки см. в [Пресеты конвертации](/ru/tools/conversion-presets).
|
||||
|
||||
### Основное {#essentials}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `resize` | Изменение размера | `width`, `height`, `fit` (cover/contain/fill/inside/outside), `percentage`, `withoutEnlargement`, плюс 23 пресета для соцсетей |
|
||||
| `crop` | Обрезка | `left`, `top`, `width`, `height`, `unit` (px/percent) |
|
||||
| `rotate` | Поворот и отражение | `angle`, `horizontal` (bool), `vertical` (bool) |
|
||||
| `convert` | Конвертация | `format` (jpg/png/webp/avif/tiff/gif/heic/heif), `quality` |
|
||||
| `compress` | Сжатие | `mode` (quality/targetSize), `quality` (1–100), `targetSizeKb` |
|
||||
|
||||
### Оптимизация {#optimization}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `optimize-for-web` | Оптимизация для веба | `format` (webp/jpeg/avif/png), `quality`, `maxWidth`, `maxHeight`, `progressive`, `stripMetadata` |
|
||||
| `strip-metadata` | Удаление метаданных | - |
|
||||
| `edit-metadata` | Редактирование метаданных | `title`, `description`, `author`, `copyright`, `keywords`, `gps` (lat/lon), `dateTime` |
|
||||
| `bulk-rename` | Массовое переименование | `pattern` (поддерживает `{n}`, `{date}`, `{original}`), `startIndex`, `padding` |
|
||||
| `image-to-pdf` | Изображение в PDF | `pageSize` (A4/Letter/...), `orientation`, `margin`, `targetSize` ({value, unit}) |
|
||||
| `favicon` | Генератор фавиконов | `padding`, `backgroundColor`, `borderRadius` - генерирует все стандартные размеры |
|
||||
|
||||
### Корректировки {#adjustments}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `adjust-colors` | Настройка цветов | `brightness`, `contrast`, `exposure`, `saturation`, `temperature`, `tint`, `hue`, `sharpness`, `red`, `green`, `blue`, `effect` (none/grayscale/sepia/invert) |
|
||||
| `sharpening` | Резкость | `method` (adaptive/unsharp-mask/high-pass), `sigma`, `m1`, `m2`, `x1`, `y2`, `y3`, `amount`, `radius`, `threshold`, `strength`, `kernelSize` (3/5), `denoise` (off/light/medium/strong) |
|
||||
| `replace-color` | Замена цвета | `sourceColor`, `targetColor` (замена), `makeTransparent`, `tolerance` |
|
||||
| `color-blindness` | Симуляция дальтонизма | `simulationType` (protanopia/deuteranopia/tritanopia/protanomaly/deuteranomaly/tritanomaly/achromatopsia/blueConeMonochromacy, по умолчанию "deuteranomaly") |
|
||||
| `duotone` | Дуотон | `shadow` (hex), `highlight` (hex), `intensity` (0-100) |
|
||||
| `pixelate` | Пикселизация | `blockSize` (2-128), `region` ({left, top, width, height} для частичной пикселизации) |
|
||||
| `vignette` | Виньетка | `strength` (0.1-1), `color` (hex), `radius`, `softness`, `roundness`, `centerX`, `centerY` |
|
||||
|
||||
### AI-инструменты {#ai-tools}
|
||||
|
||||
Все AI-инструменты работают на вашем оборудовании: по умолчанию на CPU или на NVIDIA CUDA, когда доступен поддерживаемый графический процессор NVIDIA. Аппаратное ускорение iGPU Intel/AMD через VA-API, Quick Sync или OpenCL для AI-инференса сегодня не поддерживается. Интернет не требуется.
|
||||
|
||||
| ID инструмента | Название | AI-модель | Ключевые настройки |
|
||||
|---------|------|---------|-------------|
|
||||
| `remove-background` | Удаление фона | rembg (BiRefNet / U2-Net) | `model`, `backgroundType` (transparent/color/gradient/blur/image), `backgroundColor`, `gradientColor1`, `gradientColor2`, `gradientAngle`, `blurEnabled`, `blurIntensity`, `shadowEnabled`, `shadowOpacity` |
|
||||
| `upscale` | Апскейл изображения | RealESRGAN | `scale` (2/4), `model`, `faceEnhance`, `denoise`, `format`, `quality` |
|
||||
| `erase-object` | Ластик объектов | LaMa (ONNX) | Маска отправляется как вторая файловая часть (fieldname `mask`), `format`, `quality` |
|
||||
| `ocr` | OCR / Извлечение текста | PaddleOCR / Tesseract | `quality` (fast/balanced/best), `language`, `enhance` |
|
||||
| `blur-faces` | Размытие лиц / PII | MediaPipe | `blurRadius`, `sensitivity` |
|
||||
| `smart-crop` | Умная обрезка | MediaPipe + Sharp | `mode` (subject/face/trim), `strategy` (attention/entropy), `width`, `height`, `padding`, `facePreset` (closeup/head-shoulders/upper-body/half-body), `sensitivity`, `threshold`, `padToSquare`, `padColor`, `targetSize`, `quality` |
|
||||
| `image-enhancement` | Улучшение изображения | На основе анализа | `mode` (auto/exposure/contrast/color/sharpness), `strength` |
|
||||
| `enhance-faces` | Улучшение лиц | GFPGAN / CodeFormer | `model` (gfpgan/codeformer), `strength`, `sensitivity`, `centerFace` |
|
||||
| `colorize` | AI-колоризация | DDColor | `intensity`, `model` |
|
||||
| `noise-removal` | Удаление шума | Ступенчатое шумоподавление | `tier` (quick/balanced/quality/maximum), `strength`, `detailPreservation`, `colorNoise`, `format`, `quality` |
|
||||
| `red-eye-removal` | Удаление красных глаз | Ориентиры лица + анализ цвета | `sensitivity`, `strength` |
|
||||
| `restore-photo` | Восстановление фото | Многоступенчатый конвейер | `mode` (auto/light/heavy), `scratchRemoval`, `faceEnhancement`, `fidelity`, `denoise`, `denoiseStrength`, `colorize` |
|
||||
| `passport-photo` | Фото на паспорт | Ориентиры MediaPipe | Двухфазный процесс. Анализ использует multipart `file`; генерация использует JSON с `countryCode`, `bgColor`, `printLayout` (none/4x6/a4), ориентирами, размерами изображения |
|
||||
| `content-aware-resize` | Контентно-зависимое изменение размера | Seam carving (caire) | `width`, `height`, `protectFaces`, `blurRadius`, `sobelThreshold`, `square` |
|
||||
| `transparency-fixer` | Исправление прозрачности PNG | BiRefNet HR-matting | `defringe` (0-100), `outputFormat` (png/webp) |
|
||||
| `background-replace` | Замена фона | rembg (BiRefNet) | `backgroundType` (color/gradient), `color` (hex), `gradientColor1`, `gradientColor2`, `gradientAngle`, `feather` (0-20), `format` (png/webp) |
|
||||
| `blur-background` | Размытие фона | rembg (BiRefNet) | `intensity` (1-100), `feather` (0-20), `format` (png/webp) |
|
||||
| `ai-canvas-expand` | AI-расширение холста | LaMa (outpainting) | `extendTop`, `extendRight`, `extendBottom`, `extendLeft` (px), `tier` (fast/balanced/high), `format`, `quality` |
|
||||
|
||||
### Водяной знак и наложение {#watermark-overlay}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `watermark-text` | Текстовый водяной знак | `text`, `font`, `fontSize`, `color`, `opacity`, `position`, `rotation`, `tile` |
|
||||
| `watermark-image` | Водяной знак-изображение | `opacity`, `position`, `scale` - второй файл является водяным знаком |
|
||||
| `text-overlay` | Наложение текста | `text`, `font`, `fontSize`, `color`, `x`, `y`, `background`, `padding`, `borderRadius` |
|
||||
| `compose` | Композиция изображений | `x`, `y`, `opacity`, `blend` - второй файл накладывается поверх |
|
||||
| `meme-generator` | Генератор мемов | `templateId`, `textLayout` (top-bottom/top-only/bottom-only/center/side-by-side), `textBoxes` ([{id, text}]), `fontFamily` (anton/arial-black/comic-sans/montserrat/bebas-neue/permanent-marker/roboto), `fontSize`, `textColor`, `strokeColor`, `textAlign`, `allCaps`. Поддерживает режим шаблона (тело JSON с `templateId`) или режим пользовательского изображения (multipart с файлом). |
|
||||
|
||||
### Утилиты {#utilities}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `info` | Информация об изображении | - (возвращает width, height, format, size, channels, hasAlpha, DPI, EXIF) |
|
||||
| `compare` | Сравнение изображений | `mode` (side-by-side/overlay/diff), `diffThreshold` - второй файл является целью сравнения |
|
||||
| `find-duplicates` | Поиск дубликатов | `threshold` (расстояние перцептивного хеша, по умолчанию 8) - несколько файлов |
|
||||
| `color-palette` | Цветовая палитра | `count` (количество доминирующих цветов), `format` (hex/rgb) |
|
||||
| `qr-generate` | Генератор QR-кодов | `data`, `size`, `margin`, `colorDark`, `colorLight`, `errorCorrectionLevel`, `dotStyle`, `cornerStyle`, `logo` (необязательный файл) |
|
||||
| `barcode-read` | Считыватель штрихкодов | - (автоматически определяет QR, EAN, Code128, DataMatrix и т. д.) |
|
||||
| `image-to-base64` | Изображение в Base64 | `format` (data-uri/plain), `mimeType` |
|
||||
| `html-to-image` | HTML в изображение | `url`, `format` (png/jpg/webp), `quality`, `fullPage`, `devicePreset` (desktop/tablet/mobile/custom), `viewportWidth`, `viewportHeight` |
|
||||
| `histogram` | Гистограмма | `scale` (linear/log) - возвращает график RGB-гистограммы + статистику по каналам |
|
||||
| `lqip-placeholder` | LQIP-заполнитель | `width` (4-64), `blur`, `strategy` (blur/pixelate/solid), `format` (webp/png/jpeg), `quality` |
|
||||
| `barcode-generate` | Генератор штрихкодов | `text`, `type` (code128/ean13/upca/code39/itf14/datamatrix), `scale` (1-8), `includeText` (bool). Тело JSON, без загрузки файла. |
|
||||
|
||||
### Компоновка и композиция {#layout-composition}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `collage` | Коллаж / Сетка | `template` (25+ макетов), `gap`, `backgroundColor`, `borderRadius` - несколько файлов |
|
||||
| `stitch` | Сшивка / Объединение | `direction` (horizontal/vertical/grid), `gap`, `backgroundColor`, `alignment` - несколько файлов |
|
||||
| `split` | Разделение изображения | `mode` (grid/rows/cols), `rows`, `cols`, `tileWidth`, `tileHeight` |
|
||||
| `border` | Рамка и обрамление | `width`, `color`, `style` (solid/gradient/pattern), `borderRadius`, `padding`, `shadow` |
|
||||
| `beautify` | Оформление скриншота | `backgroundType` (solid/linear-gradient/radial-gradient/image/transparent), `gradientStops`, `padding`, `borderRadius`, `shadowPreset`, `frame` (none/macos-light/macos-dark/windows-light/windows-dark/browser-light/browser-dark/iphone/macbook/ipad/...), `socialPreset` (none/twitter/linkedin/instagram-square/instagram-story/facebook/producthunt), `watermarkText`, `outputFormat` |
|
||||
| `circle-crop` | Круглая обрезка | `zoom` (1-5), `offsetX`, `offsetY`, `borderWidth`, `borderColor`, `background` (transparent/hex), `outputSize` |
|
||||
| `image-pad` | Отступы изображения | `target` (16:9/9:16/1:1/4:3/3:4/custom), `ratioW`, `ratioH`, `background` (color/transparent/blur), `color` (hex), `padding` (0-50%) |
|
||||
| `sprite-sheet` | Спрайт-лист | `columns` (1-16), `padding`, `background` (hex), `format` (png/webp/jpeg), `quality` - несколько файлов (2-64 изображения) |
|
||||
|
||||
### Формат и конвертация {#format-conversion}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `svg-to-raster` | SVG в растр | `format` (png/jpeg/webp/avif/tiff/gif/heif), `width`, `height`, `scale`, `dpi`, `background` |
|
||||
| `vectorize` | Изображение в SVG | `colorMode` (bw/color), `threshold`, `colorPrecision`, `filterSpeckle`, `pathMode` (none/polygon/spline) |
|
||||
| `gif-tools` | Инструменты GIF | `action` (resize/optimize/reverse/speed/extract-frames/rotate/add-text), параметры конкретного действия |
|
||||
| `gif-webp` | Конвертер GIF/WebP | `quality` (1-100), `lossless` (bool), `resizePercent` (10-100) |
|
||||
|
||||
### Инструменты для видео {#video-tools}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `convert-video` | Конвертация видео | `format` (mp4/mov/webm/avi/mkv), `quality` (high/balanced/small) |
|
||||
| `compress-video` | Сжатие видео | `quality` (light/balanced/strong), `resolution` (original/1080p/720p/480p) |
|
||||
| `trim-video` | Обрезка видео | `startS`, `endS`, `precise` (bool, покадрово точный срез) |
|
||||
| `mute-video` | Отключение звука видео | - |
|
||||
| `video-to-gif` | Видео в GIF | `fps` (1-30), `width`, `startS`, `durationS` (макс. 60 с) |
|
||||
| `resize-video` | Изменение размера видео | `width`, `height`, `preset` (custom/2160p/1440p/1080p/720p/480p/360p) |
|
||||
| `crop-video` | Обрезка кадра видео | `width`, `height`, `x`, `y` |
|
||||
| `rotate-video` | Поворот видео | `transform` (cw90/ccw90/180/hflip/vflip) |
|
||||
| `change-fps` | Изменение FPS | `fps` (1-120) |
|
||||
| `video-color` | Цвет видео | `brightness`, `contrast`, `saturation`, `gamma` |
|
||||
| `video-speed` | Скорость видео | `factor` (0.25-4), `keepPitch` (bool) |
|
||||
| `reverse-video` | Реверс видео | - (макс. 5 минут) |
|
||||
| `video-loudnorm` | Нормализация звука | - (EBU R128) |
|
||||
| `aspect-pad` | Отступы по соотношению сторон | `target` (16:9/9:16/1:1/4:3/3:4), `color` (hex) |
|
||||
| `blur-pad` | Отступы с размытием | `target` (16:9/9:16/1:1/4:3/3:4), `blur` (2-50) |
|
||||
| `watermark-video` | Водяной знак на видео | `text`, `position`, `fontSize`, `opacity`, `color` |
|
||||
| `stabilize-video` | Стабилизация видео | `smoothing` (5-60, в кадрах) |
|
||||
| `gif-to-video` | GIF в видео | `format` (mp4/webm/mov) |
|
||||
| `video-to-webp` | Видео в WebP | `fps`, `width`, `quality`, `loop` (bool) |
|
||||
| `video-to-frames` | Видео в кадры | `mode` (all/nth/timestamps), `n`, `timestamps`, `format` (png/jpg) |
|
||||
| `merge-videos` | Объединение видео | - (несколько файлов, приведённых к разрешению первого видео) |
|
||||
| `replace-audio` | Замена аудио | - (видео + аудиофайл, два файла) |
|
||||
| `burn-subtitles` | Вшивание субтитров | `fontSize` (8-72) - видео + файл субтитров |
|
||||
| `embed-subtitles` | Встраивание субтитров | `language` (код ISO 639-2/B) - видео + файл субтитров |
|
||||
| `extract-subtitles` | Извлечение субтитров | - (выводит SRT) |
|
||||
| `images-to-video` | Изображения в видео | `secondsPerImage` (0.5-10), `resolution` (1080p/720p/square), `fps` - несколько файлов |
|
||||
| `video-metadata` | Очистка метаданных видео | - |
|
||||
| `auto-subtitles` | Автосубтитры (AI) | `language` (auto/en/de/fr/es/zh/ja/ko/id/th/vi), `format` (srt/vtt) |
|
||||
| `extract-audio` | Извлечение аудио | `format` (mp3/wav/m4a/ogg) |
|
||||
|
||||
### Инструменты для аудио {#audio-tools}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `convert-audio` | Конвертация аудио | `format` (mp3/wav/ogg/flac/m4a), `bitrateKbps` (32-320) |
|
||||
| `trim-audio` | Обрезка аудио | `startS`, `endS` |
|
||||
| `volume-adjust` | Регулировка громкости | `gainDb` (-30 до 30) |
|
||||
| `normalize-audio` | Нормализация звука | - (EBU R128, -16 LUFS) |
|
||||
| `fade-audio` | Затухание аудио | `fadeInS` (0-30), `fadeOutS` (0-30) |
|
||||
| `reverse-audio` | Реверс аудио | - |
|
||||
| `audio-speed` | Скорость аудио | `factor` (0.25-4) |
|
||||
| `pitch-shift` | Сдвиг тона | `semitones` (-12 до 12) |
|
||||
| `audio-channels` | Аудиоканалы | `mode` (stereo-to-mono/mono-to-stereo/swap) |
|
||||
| `silence-removal` | Удаление тишины | `thresholdDb` (-80 до -20), `minSilenceS` (0.1-5) |
|
||||
| `noise-reduction` | Шумоподавление | `strength` (light/medium/strong) |
|
||||
| `merge-audio` | Объединение аудио | `format` (mp3/wav/flac/m4a) - несколько файлов |
|
||||
| `split-audio` | Разделение аудио | `mode` (time/parts/silence), `segmentS`, `parts`, `thresholdDb`, `minSilenceS` |
|
||||
| `ringtone-maker` | Создание рингтона | `startS`, `durationS` (1-30) |
|
||||
| `waveform-image` | Изображение осциллограммы | `width`, `height`, `color` (hex) |
|
||||
| `audio-metadata` | Метаданные аудио | `strip` (bool), `title`, `artist`, `album` |
|
||||
| `transcribe-audio` | Транскрибация аудио (AI) | `language` (auto/en/de/fr/es/zh/ja/ko/id/th/vi), `outputFormat` (txt/srt/vtt) |
|
||||
|
||||
### Инструменты для документов {#document-tools}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `merge-pdf` | Объединение PDF | - (несколько файлов, до 20 PDF) |
|
||||
| `split-pdf` | Разделение PDF | `mode` (range/every), `range`, `everyN` (1-500) |
|
||||
| `compress-pdf` | Сжатие PDF | `mode` (quality/targetSize), `quality` (1-100), `targetSizeKb` |
|
||||
| `rotate-pdf` | Поворот PDF | `angle` (90/180/270), `range` (диапазон страниц) |
|
||||
| `extract-pages` | Извлечение страниц | `range` (синтаксис qpdf, напр. "1-5,8,10-z") |
|
||||
| `remove-pages` | Удаление страниц | `pages` (диапазон qpdf для удаления) |
|
||||
| `organize-pdf` | Упорядочивание PDF | `order` (порядок страниц qpdf, напр. "3,1,2,5-z") |
|
||||
| `protect-pdf` | Защита PDF | `userPassword`, `ownerPassword` (AES-256) |
|
||||
| `unlock-pdf` | Снятие защиты PDF | `password` |
|
||||
| `repair-pdf` | Восстановление PDF | - |
|
||||
| `linearize-pdf` | Веб-оптимизация PDF | - (линеаризация для быстрого веб-просмотра) |
|
||||
| `grayscale-pdf` | PDF в оттенки серого | - |
|
||||
| `pdfa-convert` | Конвертация PDF/A | - (архивный PDF/A-2) |
|
||||
| `crop-pdf` | Обрезка PDF | `margin` (0-2000 пунктов) |
|
||||
| `nup-pdf` | N-up PDF | `perSheet` (2/3/4/8/9/12/16) |
|
||||
| `booklet-pdf` | Буклет PDF | `perSheet` (2/4/6/8) |
|
||||
| `watermark-pdf` | Водяной знак PDF | `text`, `position`, `fontSize`, `opacity`, `rotation` |
|
||||
| `pdf-page-numbers` | Номера страниц PDF | `position` (bl/bc/br/tl/tc/tr), `fontSize` |
|
||||
| `flatten-pdf` | Сведение PDF | - (запекает формы и аннотации) |
|
||||
| `redact-pdf` | Редактирование (редакция) PDF | `terms` (string[]), `caseSensitive` (bool) |
|
||||
| `sign-pdf` | Подписание PDF | Пользовательский multipart-маршрут с PDF `file`, файлами подписи `sig0`, `sig1` и JSON-массивом `placements` |
|
||||
| `pdf-to-text` | PDF в текст | - |
|
||||
| `pdf-to-word` | PDF в Word | - |
|
||||
| `pdf-metadata` | Метаданные PDF | `title`, `author`, `subject`, `keywords` |
|
||||
| `convert-document` | Конвертация документа | `format` (docx/odt/rtf/txt) |
|
||||
| `convert-presentation` | Конвертация презентации | `format` (pptx/odp) |
|
||||
| `convert-spreadsheet` | Конвертация таблицы | `format` (xlsx/ods/csv) |
|
||||
| `excel-to-pdf` | Excel в PDF | - |
|
||||
| `word-to-pdf` | Word в PDF | - |
|
||||
| `powerpoint-to-pdf` | PowerPoint в PDF | - |
|
||||
| `html-to-pdf` | HTML в PDF | - (удалённые ресурсы отключены) |
|
||||
| `markdown-to-docx` | Markdown в Word | - |
|
||||
| `markdown-to-html` | Markdown в HTML | - |
|
||||
| `markdown-to-pdf` | Markdown в PDF | - (удалённые ресурсы отключены) |
|
||||
| `epub-convert` | Конвертация EPUB | `format` (pdf/docx/html/md) |
|
||||
| `to-epub` | Конвертация в EPUB | - (принимает .docx, .md, .html, .txt) |
|
||||
| `ocr-pdf` | PDF OCR (AI) | `quality` (fast/balanced/best), `language` (auto/en/de/fr/es/zh/ja/ko), `pages` |
|
||||
| `pdf-to-image` | PDF в изображение | `pages` (all/range), `format`, `dpi`, `quality` |
|
||||
| `pdf-to-jpg` | PDF в JPG | `pages`, `dpi`, `quality`, `colorMode` |
|
||||
| `pdf-to-png` | PDF в PNG | `pages`, `dpi`, `quality`, `colorMode` |
|
||||
| `pdf-to-tiff` | PDF в TIFF | `pages`, `dpi`, `quality`, `colorMode` |
|
||||
|
||||
### Инструменты для файлов {#file-tools}
|
||||
|
||||
| ID инструмента | Название | Ключевые настройки |
|
||||
|---------|------|-------------|
|
||||
| `chart-maker` | Конструктор диаграмм | `kind` (bar/line/pie), `title`, `width`, `height` |
|
||||
| `csv-excel` | CSV в Excel | `sheet` (номер листа для входа XLSX) - двунаправленный |
|
||||
| `csv-json` | CSV в JSON | `pretty` (bool) - двунаправленный |
|
||||
| `json-xml` | JSON в XML | `pretty` (bool) - двунаправленный |
|
||||
| `split-csv` | Разделение CSV | `rowsPerFile` (1-1000000), `keepHeader` (bool) |
|
||||
| `merge-csvs` | Объединение CSV | - (несколько файлов, совпадающие столбцы) |
|
||||
| `yaml-json` | YAML / JSON | - (двунаправленный) |
|
||||
| `xml-to-csv` | XML в CSV | - (автоматически находит повторяющиеся элементы) |
|
||||
| `excel-to-csv` | Excel в CSV | специальный пресет конвертации на основе `convert-spreadsheet` |
|
||||
| `create-zip` | Создание ZIP | - (несколько файлов, 2-50 файлов) |
|
||||
| `extract-zip` | Извлечение ZIP | - (защита от zip-бомб) |
|
||||
|
||||
### HTML в изображение {#html-to-image}
|
||||
|
||||
Снимок веб-страницы в виде изображения. В отличие от других инструментов, этот эндпоинт принимает `application/json` вместо multipart-формы (загрузка файла не требуется).
|
||||
|
||||
**Эндпоинт:** `POST /api/v1/tools/image/html-to-image`
|
||||
|
||||
**Content-Type:** `application/json`
|
||||
|
||||
| Параметр | Тип | По умолчанию | Описание |
|
||||
|-----------|------|---------|-------------|
|
||||
| `url` | string | (обязательно) | URL для захвата (только http/https) |
|
||||
| `format` | string | `"png"` | Выходной формат: `jpg`, `png`, `webp` |
|
||||
| `quality` | number | `90` | Качество 1-100 (только JPG/WebP) |
|
||||
| `fullPage` | boolean | `false` | Захват всей прокручиваемой страницы |
|
||||
| `devicePreset` | string | `"desktop"` | `desktop`, `tablet`, `mobile`, `custom` |
|
||||
| `viewportWidth` | number | `1280` | Пользовательская ширина области просмотра 320-3840 |
|
||||
| `viewportHeight` | number | `720` | Пользовательская высота области просмотра 320-2160 |
|
||||
|
||||
**Пример:**
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/image/html-to-image \
|
||||
-H "Authorization: Bearer $TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"url": "https://snapotter.com", "format": "png", "devicePreset": "desktop"}'
|
||||
```
|
||||
|
||||
**Ответ:**
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "uuid",
|
||||
"downloadUrl": "/api/v1/download/{jobId}/screenshot.png",
|
||||
"originalSize": 0,
|
||||
"processedSize": 54321
|
||||
}
|
||||
```
|
||||
|
||||
### Подмаршруты инструментов {#tool-sub-routes}
|
||||
|
||||
Некоторые инструменты предоставляют дополнительные эндпоинты помимо стандартного `POST /api/v1/tools/<section>/<toolId>`:
|
||||
|
||||
| Метод | Путь | Описание |
|
||||
|--------|------|-------------|
|
||||
| `GET` | `/api/v1/tools/popular` | Возвращает популярные ID инструментов, откатываясь к кураторскому списку по умолчанию, когда данных об использовании мало |
|
||||
| `POST` | `/api/v1/tools/image/remove-background/effects` | Применяет фоновые эффекты (color/gradient/blur/shadow) без повторного запуска AI. Использует кешированную маску от исходного удаления. |
|
||||
| `POST` | `/api/v1/tools/image/edit-metadata/inspect` | Читает существующие метаданные EXIF/IPTC/XMP из изображения |
|
||||
| `POST` | `/api/v1/tools/image/strip-metadata/inspect` | Проверка полей метаданных перед удалением |
|
||||
| `POST` | `/api/v1/tools/image/passport-photo/analyze` | Фаза 1: AI-детекция лиц + удаление фона. Возвращает ориентиры лица и кешированные данные. |
|
||||
| `POST` | `/api/v1/tools/image/passport-photo/generate` | Фаза 2: Обрезка, изменение размера и разбиение на плитки с использованием кешированного анализа. Без повторного запуска AI. |
|
||||
| `POST` | `/api/v1/tools/image/gif-tools/info` | Получение метаданных GIF (количество кадров, размеры, длительность) |
|
||||
| `POST` | `/api/v1/tools/pdf/pdf-to-image/info` | Получение метаданных PDF (количество страниц, размеры) |
|
||||
| `POST` | `/api/v1/tools/pdf/pdf-to-image/preview` | Генерация превью конкретной страницы PDF |
|
||||
| `POST` | `/api/v1/tools/pdf/pdf-to-jpg/info` | Получение метаданных PDF для специального пресета JPG |
|
||||
| `POST` | `/api/v1/tools/pdf/pdf-to-jpg/preview` | Генерация превью страницы PDF для пресета JPG |
|
||||
| `POST` | `/api/v1/tools/pdf/pdf-to-png/info` | Получение метаданных PDF для специального пресета PNG |
|
||||
| `POST` | `/api/v1/tools/pdf/pdf-to-png/preview` | Генерация превью страницы PDF для пресета PNG |
|
||||
| `POST` | `/api/v1/tools/pdf/pdf-to-tiff/info` | Получение метаданных PDF для специального пресета TIFF |
|
||||
| `POST` | `/api/v1/tools/pdf/pdf-to-tiff/preview` | Генерация превью страницы PDF для пресета TIFF |
|
||||
| `POST` | `/api/v1/tools/image/svg-to-raster/batch` | Пакетная конвертация нескольких SVG в растр |
|
||||
| `POST` | `/api/v1/tools/image/image-enhancement/analyze` | Анализ качества изображения и возврат рекомендаций по улучшению |
|
||||
| `POST` | `/api/v1/tools/image/optimize-for-web/preview` | Лёгкое превью для настройки параметров в реальном времени. Возвращает оптимизированное изображение с заголовками размера. |
|
||||
|
||||
## Пакетная обработка {#batch-processing}
|
||||
|
||||
Применение общего инструмента с поддержкой пакетной обработки к нескольким файлам сразу. Возвращает ZIP-архив. Пользовательские многофайловые или многошаговые маршруты, такие как подписание PDF, PDF OCR и маршруты пресетов PDF-в-изображение, используют собственный контракт эндпоинта вместо общего маршрута `/batch`.
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/image/compress/batch \
|
||||
-H "Authorization: Bearer <token>" \
|
||||
-F "files=@a.jpg" \
|
||||
-F "files=@b.jpg" \
|
||||
-F "files=@c.jpg" \
|
||||
-F 'settings={"quality":80}'
|
||||
```
|
||||
|
||||
Параллелизм контролируется через `CONCURRENT_JOBS` (по умолчанию: автоопределение по ядрам CPU). `MAX_BATCH_SIZE` ограничивает количество файлов на пакет (по умолчанию: 100; установите 0 для снятия ограничения).
|
||||
|
||||
## Конвейеры {#pipelines}
|
||||
|
||||
### Выполнение конвейера {#execute-a-pipeline}
|
||||
|
||||
```bash
|
||||
# Single file
|
||||
curl -X POST http://localhost:1349/api/v1/pipeline/execute \
|
||||
-H "Authorization: Bearer <token>" \
|
||||
-F "file=@input.jpg" \
|
||||
-F 'pipeline={"steps":[
|
||||
{"toolId":"resize","settings":{"width":1200}},
|
||||
{"toolId":"compress","settings":{"quality":80}},
|
||||
{"toolId":"watermark-text","settings":{"text":"© 2025"}}
|
||||
]}'
|
||||
|
||||
# Batch (multiple files → ZIP)
|
||||
curl -X POST http://localhost:1349/api/v1/pipeline/batch \
|
||||
-H "Authorization: Bearer <token>" \
|
||||
-F "files=@a.jpg" \
|
||||
-F "files=@b.jpg" \
|
||||
-F 'pipeline={"steps":[{"toolId":"resize","settings":{"width":800}}]}'
|
||||
```
|
||||
|
||||
Выход каждого шага является входом следующего шага. Конвейеры по умолчанию допускают 20 шагов, настраивается через `MAX_PIPELINE_STEPS`. Установите `MAX_PIPELINE_STEPS=0` для снятия ограничения.
|
||||
|
||||
### Сохранение и управление конвейерами {#save-and-manage-pipelines}
|
||||
|
||||
| Метод | Путь | Описание |
|
||||
|--------|------|-------------|
|
||||
| `POST` | `/api/v1/pipeline/save` | Сохранить именованный конвейер (`name`, `description`, `steps[]`) |
|
||||
| `GET` | `/api/v1/pipeline/list` | Список сохранённых конвейеров (администраторы видят все; пользователи видят свои) |
|
||||
| `DELETE` | `/api/v1/pipeline/:id` | Удалить (владелец или администратор) |
|
||||
| `GET` | `/api/v1/pipeline/tools` | Список ID инструментов, допустимых для шагов конвейера |
|
||||
|
||||
## Отслеживание прогресса {#progress-tracking}
|
||||
|
||||
Долго выполняющиеся задания, поставленные в очередь инструменты, пакетные задания и конвейеры передают прогресс в реальном времени через Server-Sent Events. Поток прогресса публичен и привязан к идентификатору задания, поэтому клиентам не нужно отправлять заголовок Authorization для его чтения.
|
||||
|
||||
```bash
|
||||
# Connect to the SSE stream (jobId is in the JSON response body from the tool endpoint)
|
||||
curl -N http://localhost:1349/api/v1/jobs/<jobId>/progress
|
||||
```
|
||||
|
||||
Формат события:
|
||||
```
|
||||
data: {"jobId":"...","type":"single","phase":"processing","stage":"Upscaling","percent":42}
|
||||
data: {"jobId":"...","type":"single","phase":"complete","percent":100,"result":{"downloadUrl":"/api/v1/download/..."}}
|
||||
data: {"jobId":"...","type":"batch","status":"processing","completedFiles":2,"totalFiles":5,"failedFiles":0,"errors":[]}
|
||||
```
|
||||
|
||||
Вы можете запросить отмену поставленного в очередь или выполняющегося задания через `POST /api/v1/jobs/:jobId/cancel`. Ответом будет `{"canceled":true|false}`.
|
||||
|
||||
## Файловая библиотека {#file-library}
|
||||
|
||||
Постоянное хранилище файлов с историей версий.
|
||||
|
||||
| Метод | Путь | Описание |
|
||||
|--------|------|-------------|
|
||||
| `POST` | `/api/v1/upload` | Загрузка файлов в рабочую область (временная обработка) |
|
||||
| `POST` | `/api/v1/files/upload` | Загрузка файлов в постоянную файловую библиотеку |
|
||||
| `POST` | `/api/v1/files/save-result` | Сохранение результата обработки инструмента как новой версии файла |
|
||||
| `GET` | `/api/v1/files` | Список сохранённых файлов (с пагинацией и поиском) |
|
||||
| `GET` | `/api/v1/files/:id` | Получение метаданных файла + цепочки версий |
|
||||
| `GET` | `/api/v1/files/:id/download` | Загрузка файла |
|
||||
| `GET` | `/api/v1/files/:id/thumbnail` | Получение JPEG-миниатюры 300px |
|
||||
| `DELETE` | `/api/v1/files` | Массовое удаление файлов и их цепочек версий (тело: `{ ids: [...] }`) |
|
||||
| `POST` | `/api/v1/fetch-urls` | Загрузка удалённых URL в рабочую область для импорта по URL |
|
||||
| `POST` | `/api/v1/preview` | Генерация совместимого с браузером WebP-превью (для форматов HEIC/HEIF/RAW) |
|
||||
| `GET` | `/api/v1/files/:id/preview` | Потоковая передача кешированного или сгенерированного совместимого с браузером превью для сохранённого PDF, офисного документа, видео- или аудиофайла |
|
||||
| `POST` | `/api/v1/preview/generate` | Генерация MP4- или MP3-превью по запросу для загруженного медиафайла без предварительного сохранения |
|
||||
| `GET` | `/api/v1/download/:jobId/:filename` | Загрузка обработанного файла из рабочей области |
|
||||
|
||||
Чтобы автоматически сохранить результат инструмента в библиотеку, включите `fileId` как поле multipart-формы, ссылающееся на существующий файл библиотеки. Обработанный результат будет сохранён как новая версия.
|
||||
|
||||
## Управление API-ключами {#api-key-management}
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `POST` | `/api/v1/api-keys` | Auth | Генерация нового ключа - показывается один раз |
|
||||
| `GET` | `/api/v1/api-keys` | Auth | Список ключей (name, id, lastUsedAt - не необработанный ключ) |
|
||||
| `DELETE` | `/api/v1/api-keys/:id` | Auth | Удаление ключа |
|
||||
|
||||
## Команды {#teams}
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/teams` | Admin (`teams:manage`) | Список команд |
|
||||
| `POST` | `/api/v1/teams` | Admin (`teams:manage`) | Создание команды |
|
||||
| `PUT` | `/api/v1/teams/:id` | Admin (`teams:manage`) | Переименование команды |
|
||||
| `DELETE` | `/api/v1/teams/:id` | Admin (`teams:manage`) | Удаление команды (нельзя удалить команду по умолчанию или команды с участниками) |
|
||||
|
||||
## Настройки {#settings}
|
||||
|
||||
Конфигурация «ключ-значение» во время выполнения (чтение любым аутентифицированным пользователем, запись только администратором).
|
||||
|
||||
| Метод | Путь | Описание |
|
||||
|--------|------|-------------|
|
||||
| `GET` | `/api/v1/settings` | Получить все настройки |
|
||||
| `PUT` | `/api/v1/settings` | Массовое обновление настроек (тело JSON с парами «ключ-значение») |
|
||||
| `GET` | `/api/v1/settings/:key` | Получить конкретную настройку по ключу |
|
||||
|
||||
Известные ключи: `disabledTools` (JSON-массив ID инструментов), `enableExperimentalTools` (строка bool), `loginAttemptLimit` (число).
|
||||
|
||||
## Предпочтения {#preferences}
|
||||
|
||||
Пользовательские предпочтения отделены от настроек экземпляра. Любой аутентифицированный пользователь может читать и обновлять собственную карту предпочтений.
|
||||
|
||||
| Метод | Путь | Описание |
|
||||
|--------|------|-------------|
|
||||
| `GET` | `/api/v1/preferences` | Получить предпочтения текущего пользователя как `{ "preferences": { ... } }` |
|
||||
| `PUT` | `/api/v1/preferences` | Вставить или обновить один или несколько ключей предпочтений для текущего пользователя |
|
||||
|
||||
## Роли {#roles}
|
||||
|
||||
Управление пользовательскими ролями с гранулярными разрешениями.
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/roles` | Admin (`audit:read`) | Список всех ролей с количеством пользователей |
|
||||
| `POST` | `/api/v1/roles` | Admin (`security:manage`) | Создание пользовательской роли (`name`, `description`, `permissions`) |
|
||||
| `PUT` | `/api/v1/roles/:id` | Admin (`security:manage`) | Обновление пользовательской роли (нельзя изменять встроенные роли) |
|
||||
| `DELETE` | `/api/v1/roles/:id` | Admin (`security:manage`) | Удаление пользовательской роли (нельзя удалять встроенные роли; затронутые пользователи возвращаются к роли `user`) |
|
||||
|
||||
Доступные разрешения (17): `tools:use`, `files:own`, `files:all`, `apikeys:own`, `apikeys:all`, `pipelines:own`, `pipelines:all`, `settings:read`, `settings:write`, `users:manage`, `teams:manage`, `features:manage`, `system:health`, `audit:read`, `compliance:manage`, `webhooks:manage`, `security:manage`.
|
||||
|
||||
## Журнал аудита {#audit-log}
|
||||
|
||||
Эндпоинт только для администраторов для просмотра действий, связанных с безопасностью.
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/audit-log` | Admin (`audit:read`) | Журнал аудита с пагинацией и необязательными фильтрами |
|
||||
|
||||
Параметры запроса:
|
||||
|
||||
| Параметр | Описание |
|
||||
|-----------|-------------|
|
||||
| `page` | Номер страницы (по умолчанию: 1) |
|
||||
| `limit` | Записей на страницу (по умолчанию: 50, макс.: 100) |
|
||||
| `action` | Фильтр по типу действия (напр. `ROLE_CREATED`, `ROLE_DELETED`) |
|
||||
| `ip` | Фильтр по исходному IP-адресу |
|
||||
| `from` | Фильтр записей после этой даты в формате ISO 8601 |
|
||||
| `to` | Фильтр записей до этой даты в формате ISO 8601 |
|
||||
|
||||
## Аналитика {#analytics}
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/config/analytics` | Публичный | Получить действующую конфигурацию аналитики (ключ PostHog, Sentry DSN, частота выборки). Ключи, DSN и идентификатор экземпляра пусты, когда аналитика выключена, будь то из-за настройки на этапе компиляции или настройки экземпляра `analyticsEnabled`. |
|
||||
| `POST` | `/api/v1/feedback` | Auth | Отправить явную обратную связь пользователя в настроенный проект PostHog как `feedback_submitted`. Маршрут учитывает шлюз аналитики, ограничивает частоту отправок, удаляет контактные поля, если `contactOk` не равно true, и никогда не принимает содержимое файлов, имена файлов, пути загрузки или необработанный текст приватных ошибок. Когда аналитика отключена, он возвращает `{ "ok": true, "accepted": false }`. |
|
||||
| `PUT` | `/api/v1/settings` | Admin (`settings:write`) | Установить отказ на уровне всего экземпляра. Отправьте тело JSON `{ "analyticsEnabled": "false" }`, чтобы отключить аналитику для всех, или `"true"`, чтобы снова включить её. |
|
||||
|
||||
## Функции / AI-бандлы {#features-ai-bundles}
|
||||
|
||||
Управление бандлами AI-функций (установка/удаление пакетов AI-моделей в среде Docker). Предпочтительнее использовать эндпоинт установки на уровне инструмента при включении инструмента из пользовательской автоматизации: некоторым AI-инструментам нужно более одного общего бандла, и этот эндпоинт пропускает уже установленные бандлы, ставя в очередь только недостающие.
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/features` | Auth | Список всех бандлов функций и их статуса установки |
|
||||
| `POST` | `/api/v1/admin/features/:bundleId/install` | Admin (`features:manage`) | Установить бандл функции (асинхронно, возвращает `jobId` для отслеживания прогресса) |
|
||||
| `POST` | `/api/v1/admin/tools/:toolId/features/install` | Admin (`features:manage`) | Установить каждый бандл, который требуется инструменту; возвращает статус queued/skipped по каждому бандлу |
|
||||
| `POST` | `/api/v1/admin/features/:bundleId/uninstall` | Admin (`features:manage`) | Удалить бандл функции и очистить файлы моделей |
|
||||
| `GET` | `/api/v1/admin/features/disk-usage` | Admin (`features:manage`) | Получить общее использование диска AI-моделями |
|
||||
| `POST` | `/api/v1/admin/features/import` | Admin (`features:manage`) | Импортировать офлайн-архив AI-бандла |
|
||||
|
||||
## Административные операции {#admin-operations}
|
||||
|
||||
Операционные эндпоинты для наблюдаемости, поддержки, отчётности об использовании и статуса резервного копирования.
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/admin/log-level` | Admin (`settings:write`) | Прочитать текущий уровень логирования во время выполнения |
|
||||
| `POST` | `/api/v1/admin/log-level` | Admin (`settings:write`) | Изменить уровень логирования во время выполнения (`fatal`, `error`, `warn`, `info`, `debug`, `trace` или `silent`) |
|
||||
| `GET` | `/api/v1/metrics` | Admin (`system:health`) | Метрики Prometheus в текстовом формате |
|
||||
| `GET` | `/api/v1/admin/support-bundle` | Admin (`system:health`) | Загрузить отредактированный диагностический ZIP-бандл поддержки |
|
||||
| `GET` | `/api/v1/admin/usage` | Admin (`audit:read`) | Данные панели использования, с необязательным параметром запроса `days` |
|
||||
| `GET` | `/api/v1/admin/backup-status` | Admin (`system:health`) | Прочитать метаданные последнего резервного копирования и статус актуальности |
|
||||
| `POST` | `/api/v1/admin/backup-status` | Admin (`system:health`) | Записать завершённое резервное копирование (`type`, необязательно `sizeBytes`, необязательно `notes`) |
|
||||
|
||||
## Enterprise API {#enterprise-apis}
|
||||
|
||||
Эти маршруты ограничены лицензией через связанную с ними enterprise-функцию. Они по-прежнему требуют указанного разрешения SnapOtter.
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/enterprise/audit/export` | Admin (`audit:read`) | Экспорт записей аудита в JSON или CSV с фильтрами |
|
||||
| `GET` | `/api/v1/enterprise/config/export` | Admin (`system:health`) | Экспорт отредактированной конфигурации экземпляра, пользовательских ролей и команд |
|
||||
| `POST` | `/api/v1/enterprise/config/import` | Admin (`system:health`) | Импорт конфигурации, с необязательным пробным запуском |
|
||||
| `GET` | `/api/v1/enterprise/ip-allowlist` | Admin (`security:manage`) | Прочитать настроенный список разрешённых CIDR |
|
||||
| `PUT` | `/api/v1/enterprise/ip-allowlist` | Admin (`security:manage`) | Обновить список разрешённых CIDR с предотвращением самоблокировки |
|
||||
| `GET` | `/api/v1/enterprise/legal-hold` | Admin (`compliance:manage`) | Список правовых блокировок пользователей и команд |
|
||||
| `PUT` | `/api/v1/enterprise/legal-hold` | Admin (`compliance:manage`) | Применить или снять правовую блокировку с пользователя или команды |
|
||||
| `POST` | `/api/v1/enterprise/scim/token` | Admin (`users:manage`) | Сгенерировать bearer-токен SCIM, возвращается один раз |
|
||||
| `DELETE` | `/api/v1/enterprise/scim/token` | Admin (`users:manage`) | Отозвать текущий bearer-токен SCIM |
|
||||
| `GET` | `/api/v1/enterprise/siem/config` | Admin (`webhooks:manage`) | Прочитать конфигурацию пересылки SIEM |
|
||||
| `PUT` | `/api/v1/enterprise/siem/config` | Admin (`webhooks:manage`) | Обновить конфигурацию пересылки SIEM |
|
||||
| `GET` | `/api/v1/enterprise/webhooks` | Admin (`webhooks:manage`) | Список назначений вебхуков |
|
||||
| `POST` | `/api/v1/enterprise/webhooks` | Admin (`webhooks:manage`) | Создать назначение вебхука |
|
||||
| `PUT` | `/api/v1/enterprise/webhooks/:index` | Admin (`webhooks:manage`) | Обновить назначение вебхука |
|
||||
| `DELETE` | `/api/v1/enterprise/webhooks/:index` | Admin (`webhooks:manage`) | Удалить назначение вебхука |
|
||||
| `POST` | `/api/v1/enterprise/webhooks/:index/test` | Admin (`webhooks:manage`) | Отправить тестовую полезную нагрузку вебхука |
|
||||
| `POST` | `/api/v1/enterprise/users/:id/export` | Admin (`compliance:manage`) | Запустить задание экспорта пользователя по GDPR |
|
||||
| `GET` | `/api/v1/enterprise/users/:id/export/:jobId` | Admin (`compliance:manage`) | Прочитать статус экспорта GDPR и URL для загрузки |
|
||||
| `DELETE` | `/api/v1/enterprise/users/:id/purge` | Admin (`compliance:manage`) | Безвозвратно очистить данные пользователя после подтверждения |
|
||||
| `DELETE` | `/api/v1/enterprise/teams/:id/purge` | Admin (`compliance:manage`) | Безвозвратно очистить данные команды после подтверждения |
|
||||
| `GET` | `/api/v1/admin/version` | Admin (`system:health`) | Прочитать метаданные версии приложения, сборки, Node и схемы |
|
||||
| `GET` | `/api/v1/admin/migrations/pending` | Admin (`system:health`) | Сравнить упакованные миграции с применёнными миграциями |
|
||||
| `GET` | `/api/v1/admin/upgrade-check` | Admin (`system:health`) | Запустить проверки готовности к обновлению |
|
||||
|
||||
### SCIM 2.0 {#scim-2-0}
|
||||
|
||||
Эндпоинты обнаружения SCIM публичны. Эндпоинты пользователей и групп требуют bearer-токена SCIM, сгенерированного выше.
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/scim/v2/ServiceProviderConfig` | Публичный | Возможности сервера SCIM |
|
||||
| `GET` | `/api/v1/scim/v2/Schemas` | Публичный | Обнаружение схемы SCIM |
|
||||
| `GET` | `/api/v1/scim/v2/ResourceTypes` | Публичный | Обнаружение типов ресурсов SCIM |
|
||||
| `GET` | `/api/v1/scim/v2/Users` | Токен SCIM | Список пользователей, с необязательным фильтром SCIM |
|
||||
| `POST` | `/api/v1/scim/v2/Users` | Токен SCIM | Создать пользователя |
|
||||
| `GET` | `/api/v1/scim/v2/Users/:id` | Токен SCIM | Получить пользователя |
|
||||
| `PUT` | `/api/v1/scim/v2/Users/:id` | Токен SCIM | Заменить пользователя |
|
||||
| `DELETE` | `/api/v1/scim/v2/Users/:id` | Токен SCIM | Мягкая деактивация пользователя |
|
||||
| `GET` | `/api/v1/scim/v2/Groups` | Токен SCIM | Список команд как групп SCIM |
|
||||
| `POST` | `/api/v1/scim/v2/Groups` | Токен SCIM | Создать команду |
|
||||
| `GET` | `/api/v1/scim/v2/Groups/:id` | Токен SCIM | Получить команду |
|
||||
| `PUT` | `/api/v1/scim/v2/Groups/:id` | Токен SCIM | Заменить команду и членство в группе |
|
||||
| `DELETE` | `/api/v1/scim/v2/Groups/:id` | Токен SCIM | Удалить команду |
|
||||
|
||||
## Шаблоны мемов {#meme-templates}
|
||||
|
||||
Вспомогательный API для инструмента генератора мемов.
|
||||
|
||||
| Метод | Путь | Доступ | Описание |
|
||||
|--------|------|--------|-------------|
|
||||
| `GET` | `/api/v1/meme-templates` | Auth | Список всех доступных шаблонов мемов с позициями текстовых полей |
|
||||
| `GET` | `/api/v1/meme-templates/full/:filename` | Auth | Отдать полноразмерное изображение шаблона |
|
||||
| `GET` | `/api/v1/meme-templates/thumbs/:filename` | Auth | Отдать миниатюру шаблона |
|
||||
| `GET` | `/api/v1/meme-templates/fonts/:filename` | Auth | Отдать файл шрифта, используемый для отрисовки текста мема |
|
||||
|
||||
## Ответы с ошибками {#error-responses}
|
||||
|
||||
Все ошибки возвращают JSON:
|
||||
|
||||
```json
|
||||
{
|
||||
"error": "Human-readable message",
|
||||
"code": "MACHINE_READABLE_CODE"
|
||||
}
|
||||
```
|
||||
|
||||
| Статус | Значение |
|
||||
|--------|---------|
|
||||
| 400 | Недопустимый запрос / ошибка валидации |
|
||||
| 401 | Не аутентифицирован |
|
||||
| 403 | Недостаточно разрешений |
|
||||
| 404 | Ресурс не найден |
|
||||
| 413 | Файл слишком большой (см. `MAX_UPLOAD_SIZE_MB`) |
|
||||
| 422 | Обработка не удалась после валидации |
|
||||
| 429 | Ограничение частоты запросов (см. `RATE_LIMIT_PER_MIN`) |
|
||||
| 501 | Требуемый AI-бандл функции не установлен (`FEATURE_NOT_INSTALLED`) |
|
||||
| 500 | Внутренняя ошибка сервера |
|
||||
Reference in New Issue
Block a user