Интеллос предоставляет полный набор Knowledge Base API, который позволяет программно управлять базами знаний, документами и чанками. Это удобно для автоматизации синхронизации данных или встраивания операций с базой знаний в CI/CD-конвейеры. Доступ к API включён по умолчанию при создании базы знаний. Чтобы начать выполнять API-вызовы, вам нужны только учётные данные API: эндпоинт и ключ.
Один ключ Knowledge Base API имеет доступ ко всем видимым базам знаний в рамках одной учётной записи. Обращайтесь с учётными данными аккуратно, чтобы избежать непреднамеренного раскрытия данных.

Получение эндпоинта и ключа API

Перейдите в раздел Знания в Интеллос. В правом верхнем углу нажмите Service API, чтобы открыть панель настройки API. Здесь вы можете:
  • Получить эндпоинт Service API. Это базовый URL для всех запросов к Knowledge Base API.
  • Нажать API Key, чтобы создать новые ключи и управлять существующими.
    Храните ключ API в безопасности на стороне сервера. Никогда не раскрывайте его в клиентском коде или публичных репозиториях.

Управление доступом к API для базы знаний

Каждая база знаний по умолчанию доступна через Service API. Если вы хотите ограничить доступ к API для конкретной базы знаний, откройте её, затем нажмите Доступ к API в левом нижнем углу и отключите этот параметр.

Справочник по API

См. справочник по Knowledge Base API, где приведён полный список эндпоинтов, схемы запросов и ответов, коды ошибок и интерактивные примеры.