Документация / Начало работы

Быстрый старт

Превью для разработчиков

Три шага: получите токен, выполните поиск, задайте вопрос. Конечные точки с пометкой «Доступно» работают сегодня; с пометкой «Планируется» появятся вместе с открытым ядром.

1
Получите токен
Токен лежит в файле token в каталоге данных. Он создаётся автоматически при первом запуске и доступен для чтения только текущему пользователю.
Терминал
cat <каталог_данных>/token
# Нужен для каждой конечной точки /api/v1; по умолчанию слушает только 127.0.0.1:8090
2
Поиск
Ищите материалы на естественном языке. Результаты содержат файл, место и фрагмент и не зависят от имён файлов.
Терминал
curl http://127.0.0.1:8090/api/v1/search \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"query": "условия оплаты в договоре с поставщиком", "top_k": 5}'
3
Вопросы
Ответ идёт потоком. При включённом search она отвечает только по вашим файлам и указывает источники.
Терминал
curl -N http://127.0.0.1:8090/api/v1/chat/stream \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"messages": [{"role": "user", "content": "Что решили на прошлой неделе на встрече?"}],
       "search": true}'

Статус API

APIЧто делаетСтатус
MCP · ownward-mcp
Позволяет агентам с поддержкой MCP напрямую пользоваться поиском, вопросами и ответами и библиотекой; инструменты с побочными эффектами не открываются.
Доступно
POST /api/v1/search
Единый поиск по документам, изображениям, аудио и видео.
Доступно
POST /api/v1/search-image
Поиск изображений по изображению.
Доступно
POST /api/v1/search/video-clips
Находит нужный фрагмент в видео.
Доступно
POST /api/v1/chat/stream
Вопросы и ответы потоком по SSE, с источниками.
Доступно
POST /api/v1/generate
Генерация изображений и видео. Длина, которую устройство не успеет обработать, отклоняется сразу, и возвращается поддерживаемый максимум.
Доступно
GET /hub/index.json
Каталог сценариев; перед сохранением проверяется по sha256.
Доступно
SDK · Python / JS / C++
Оформляет перечисленные выше конечные точки в клиентские библиотеки для разных языков.
Планируется
API, совместимый с OpenAI
Существующие инструменты подключаются сменой адреса конечной точки.
Планируется
Коннекторы MCP
Подключение сторонних инструментов и источников данных через MCP.
Планируется

Модели

У каждого типа задач есть вариант по умолчанию, который можно заменить в настройках. Облачные модели — по желанию и по умолчанию выключены.

Поиск
Текст и мультимодальность
Эмбеддинги · переранжирование · разреженный поиск · визуальный анализ страниц документов
Изображения
Анализ изображений
Смысл изображения и текста · лица · OCR · подписи
Аудио
Анализ аудио
Расшифровка · пословное выравнивание · говорящие · события
Видео
Анализ видео
Определение кадров · обнаружение и отслеживание
Диалог
Вопросы и ответы и планирование
Локальные чат-модели
Генерация
Изображения и видео
Изображения · видео · синтез речи
Документация
Анализ вёрстки
Структура страницы · понимание на уровне элементов
Заменяемо
Без привязки
Переключение по типам в настройках
Регистрация в превью для разработчиков скоро откроется
Регистрация готовится; когда она откроется, мы объявим об этом здесь.