Документация
Ключи API
Ключ API даёт программе доступ к данным проекта на чтение: срабатывания и правила. Ключ привязан к одному проекту. Менять что-либо в проекте ключом нельзя.
На этой странице
Ключ работает только с MCP-сервером SmartAlert: с ключом ИИ-ассистент видит данные вашего проекта, без ключа — только открытые инструменты. REST API ключ не принимает.
Кто может
| Тариф | Business и Enterprise. Пробный период ключи не открывает |
|---|---|
| Роль | Участник проекта с правом менять настройки. При доступе только на просмотр ключей не видно |
| Сколько | До 10 действующих ключей на проект, на любом тарифе |
Если проект ушёл с Business, ключи перестают работать: запрос с ключом получит отказ «Ключи API — на тарифе Business и выше». Отозвать их можно на любом тарифе.
Создать ключ
- Откройте Настройки → Ключи API.
- Нажмите Создать ключ и дайте ему имя: где он будет работать, например «Grafana» или «Скрипт отчёта». От 1 до 60 символов.
- Скопируйте ключ и сохраните его сразу.
Ключ показывается один раз. SmartAlert хранит только его хэш, поэтому показать ключ повторно не сможет никто. Потеряли ключ — отзовите его и создайте новый.
В списке ключ виден как начало и последние 4 символа, например sa_live_…ab12, и время последнего запроса с точностью до минуты.
Передать ключ
Ключ начинается с sa_live_. По этому началу его узнают сканеры секретов, если ключ случайно попадёт в репозиторий.
Передавайте ключ в заголовке Authorization:
Authorization: Bearer sa_live_…В адресе, теле запроса и cookie ключ не принимается.
Храните ключ как пароль: в менеджере секретов или в переменной окружения, не в коде.
Отозвать ключ
Настройки → Ключи API, кнопка Отозвать у ключа, затем подтверждение. Ключ перестаёт работать сразу и пропадает из списка. Вернуть отозванный ключ нельзя.
Подключить к Claude / Cursor
MCP-сервер SmartAlert: https://mcp.smart-alert.io/mcp. Готовый конфиг с вашим ключом есть в Настройки → Ключи API, блок «Подключить к Claude / Cursor».
Claude Code, файл .mcp.json:
{
"mcpServers": {
"smartalert": {
"type": "http",
"url": "https://mcp.smart-alert.io/mcp",
"headers": { "Authorization": "Bearer sa_live_…" }
}
}
}Cursor, файл ~/.cursor/mcp.json — то же без строки "type". Без headers работают только открытые инструменты.
Инструменты
Все инструменты только читают.
| Инструмент | Ключ | Что отдаёт |
|---|---|---|
find_contract | не нужен | Контракты публичного каталога по адресу или имени, до 10 |
contract_activity | не нужен | Активность контракта из каталога: суммы по событиям, всего и за 24 часа |
project_status | не нужен | Опубликованная статус-страница: контракты, их состояние и инциденты |
list_alerts | нужен | Срабатывания проекта за период, по умолчанию за 7 дней, до 100 за запрос |
explain_alert | нужен | Почему сработало: значение против порога или нормы, правило, контракт, решено ли |
list_rules | нужен | Правила проекта и их шум: сколько раз сработали, сколько ложных. У правила по метрике — id метрики |
metric_series | нужен | Ряд метрики проекта за период: по умолчанию 7 дней, до 200 точек. Функция count, sum, avg, min или max, разрез по лейблу |
find_contractcontract_activityproject_statuslist_alertsexplain_alertlist_rulesmetric_seriescount, sum, avg, min или max, разрез по лейблуКлюч проекта ниже Business закрытые инструменты не открывает: ассистент получит ответ «API keys work on the Business plan and above».
Лимиты
| Без ключа | 60 запросов в минуту с одного IP |
|---|---|
| С ключом | 120 запросов в минуту на ключ |
Сверх лимита — 429 и заголовок Retry-After: через сколько секунд повторить.
Ошибки
| Ответ | Что значит |
|---|---|
401 | Ключ неизвестен или отозван |
429 RATE_LIMITED | Превышен лимит запросов к MCP. Повторите через Retry-After секунд |
403 PLAN_REQUIRED | Тариф проекта ниже Business |
429 LIMIT_EXCEEDED | При создании: в проекте уже 10 ключей. Отзовите ненужный |
401429 RATE_LIMITEDRetry-After секунд403 PLAN_REQUIRED429 LIMIT_EXCEEDEDНашли ошибку или не нашли ответ? Напишите