← На главнуюДокументация
← К разделам

API и интеграции

REST API позволяет подключать внешние системы: n8n, скрипты, мобильные приложения и другие интеграции. Полная документация с эндпоинтами — в разделе API настройки (Интеграции → API настройки).

API-ключи

Для доступа к API создайте ключ в API настройках. Укажите имя (например, «n8n интеграция») и нажмите «Создать». Сохраните ключ сразу — полное значение показывается только один раз.

Ключ передаётся в заголовке:

Authorization: Bearer <ваш_ключ>

Пример запроса:

curl -X GET "https://qoqon.ru/api/v1/files" \
  -H "Authorization: Bearer qk_xxxxxxxx__yyyyyyyy"

Основные группы эндпоинтов

  • Файлы — список, загрузка, скачивание, поиск, чат по документу, транскрипция
  • Папки — создание, переименование, перемещение, удаление
  • Общий доступ — создание и отзыв публичных ссылок
  • RAG-память — коллекции, векторизация, семантический поиск по collectionId
  • Векторная база — список файлов с эмбеддингами, чанки
  • API Маркетплейс — OpenAI-совместимый Chat и Embeddings для n8n
  • Обработка и транскрипция — запуск обработки документов, транскрибация аудио
  • Генерация изображений — задачи, модели, запуск генерации, статус
  • Корзина — восстановление и удаление
  • Уведомления — список и отметка прочитанными
  • Пользователь — профиль, хранилище, настройки, AI-конфиг
  • Тарифы — список планов, текущий тариф
  • Календарь (CalDAV), почта (IMAP/SMTP), парсинг сайтов — отдельные ключи и сценарии; см. Календарь, почта и парсинг

Календарь, почта и парсинг

Подробное руководство — Календарь, почта и парсинг сайтов: мост к Яндекс.Календарю (CalDAV), к Яндекс.Почте (IMAP/SMTP) с выбором папок, парсинг веб-страниц по тарифу. Для автоматизации используются ключи cal_ и mail_, не путать с основным ключом файлов qk_.

Интеграция с n8n

Для n8n доступны:

  • Семантический поиск — GET /api/v1/files/search?q=запрос&collectionId=ID. Возвращает results[].chunkText
  • API Маркетплейс — Chat Completions и Embeddings (OpenAI-совместимый формат)
  • PGVector-подключения — для RAG-коллекций (требуется тариф с «Подключение n8n»)

Подробнее — в руководстве по интеграции с n8n.

Базовый URL

Базовый URL API отображается в разделе API настройки после входа. Обычно это https://qoqon.ru/api/v1 или ваш домен.

Часть операций (смена пароля, подписка на тариф, удаление аккаунта) доступна только через веб-интерфейс с сессией (cookie), не по API-ключу.