Полная справочная документация по всем API-интерфейсам платформы Knowledge Base
Используйте справочник API, когда знаете операцию, которую хотите реализовать, и нуждаетесь в текущей конечной точке, параметрах, схемах запроса и ответа, а также информации о статусе.
Откройте справочник API
Используйте справочник Swagger в качестве авторитетного источника для текущих определений конечных точек и деталей реализации.
Что можно найти в справочнике API
Справочник API предоставляет детали реализации для доступных операций, включая:
- HTTP-методы и пути конечных точек.
- Параметры запроса.
- Схемы запроса и ответа.
- Информация об ответе и статусе.
Доступные API охватывают функциональные области, такие как:
- Коллекции и доступ к коллекциям.
- Документы и обработка документов.
- Вывод ИИ.
- Вложения.
- Теги документов.
- Пользователи и организации.
- Отзывы.
- Настройки.
- Аналитика и отчеты.
- Интеграции ботов.
Используйте Начало работы с API Knowledge Base, если нужно ознакомиться с моделью ресурсов API, жизненным циклом обработки документов, особенностями выполнения вывода или типичной схемой запросов.
Устранение неполадок с запросами API
Ответы API-интерфейса содержат заголовок X-Request-ID, который определяет запрос в различных сервисах Knowledge Base.
Запишите X-Request-ID при устранении неполадок с неудачным запросом или при обращении в службу поддержки. Также сохраните HTTP-статус, детали ответа, конечную точку и приблизительное время запроса.
