Аутентификация
Все запросы к API требуют аутентификации через Bearer-токен в заголовке Authorization.
Bearer-токен
Включите ваш API-ключ в заголовок Authorization каждого запроса.
Примеры на разных языках
Контекст организации
Если вы являетесь участником нескольких организаций, укажите заголовок X-Org-Id для выбора контекста.
Формат токенов
API-ключи имеют префикс sk-org-. Полный секрет показывается только один раз — при создании, сохраните его надёжно. Эндпоинты списка и отзыва возвращают только префикс ключа, никогда не секрет.
Scopes
Каждый ключ несёт список scope, которые проверяются для каждого эндпоинта. Если у ключа нет нужного scope, запрос завершается ошибкой 403 AUTH_PERMISSION_DENIED. Ключ со scope admin обходит все проверки scope. Новые ключи по умолчанию получают write:tools, если scope не указаны явно.
| Scope | Доступ |
|---|---|
read:tools | Чтение метаданных инструментов и коннекторов |
write:tools | Выполнение инструментов и коннекторов |
read:data | Чтение данных вашей организации |
chat | Вызов OpenAI-совместимого эндпоинта /v1/chat/completions |
connector:gateway | Прямой доступ к шлюзу коннекторов |
admin | Полный доступ — обходит проверки scope |
Управление ключами
Ключи выпускаются, перечисляются и отзываются в рамках организации. Каждый ключ истекает через expires_in_days (по умолчанию 90, диапазон 1–365).
Ошибки аутентификации
При неверном или истёкшем токене API вернёт ответ с кодом 401.