Для доступа к публичному API Нейро42 используется механизм API-ключей. Они позволяют безопасно обращаться к платформе программно и выполнять те же операции, что и через интерфейс.
Доступность функции
Публичный API недоступен в пробном периоде. Для включения этой возможности требуется перейти на платный тариф.
API Scopes (Области доступа)
В корпоративных установках Нейро42 вы можете точно контролировать, какие ресурсы доступны конкретному API-ключу.
Scopes позволяют задать разрешения под конкретную задачу — от только чтения до полного администрирования.
На тарифах ниже Enterprise все API-ключи получают полный доступ ко всем возможностям учетной записи.
Как создать API-ключ
- Войдите в свой аккаунт Нейро42.
- Откройте меню Настройки — API Нейро42.
- Нажмите Создать API-ключ.
- Укажите Название ключа и выберите срок его действия (Expiration Time).
- Если вы используете корпоративный план — отметьте необходимые Scopes.
- Скопируйте значение Мой API-ключ — оно понадобится для всех запросов.
Как использовать API-ключ в запросах
Передавайте ключ в HTTP-заголовке X-NEURO42-API-KEY.
Пример запроса, который получает список всех активных агентов для Neuro42 Cloud
curl -X ‘GET’ \
‘<your-cloud-instance>/api/v<version>/agents?active=true’ \
-H ‘accept: application/json’ \
-H ‘X-NEURO42-API-KEY: <your-api-key>’
Удаление API-ключа
- Войдите в Нейро42.
- Перейдите в Настройки — API Нейро42.
- Нажмите Удалить напротив ключа, который хотите деактивировать.
- Подтвердите действие, выбрав Удалить навсегда.