Справочник API

Happ предоставляет REST + WebSocket API для управления агентами, отправки сообщений, контроля режима AI и интеграции Happ в ваши рабочие процессы. Полный интерактивный справочник находится в Scalar — это основной источник информации о каждом эндпоинте, схеме и примере.

api.happ.tools/reference

Группы ресурсов

Публичный справочник охватывает такие группы:

• Auth — вход, обновление токена
• Companies — воркспейсы, участники, приглашения
• Access Tokens — долгоживущие токены для интеграций
• Assistants — GET/POST /api/assistants-new, PATCH /api/assistants-new/{id}
• Assistant tools — /api/assistant-tools-new
• Assistant knowledge — /api/assistant-knowledge-new
• Chats — список чатов, отправка и список сообщений, переключение контроля AI (PATCH /api/chats/{id} isUnderAiControl)
• Calls — исходящий звонок: POST /api/assistants/{id}/originate

Всё остальное на платформе (телефоны, интеграции, биллинг, аналитика) управляется из кабинета, а не через публичный API.

Аутентификация

Для всех запросов нужен Access Token, созданный в настройках аккаунта на my.happ.tools. Отправляйте его в заголовке:

X-Access-Token: happ_your_token_here

Базовый URL (продакшн): https://api.happ.tools.

WebSocket

Подключитесь через Socket.IO к wss://api.happ.tools (пространство имён по умолчанию, без суффикса пути): аутентифицируйтесь токеном, передайте auth: { companyId } и получайте события MESSAGE_CREATED, CHAT_MODE_CHANGED и CHAT_CREATED. См. Чаты > Обновления в реальном времени.

Использование с AI

Интегрируетесь с помощью AI-ассистента (Claude, Cursor, Copilot)? Дайте ему наши машиночитаемые источники вместо копирования документации:

• Спецификация OpenAPI — https://api.happ.tools/api/swagger-json (все эндпоинты, схемы и правила авторизации)
• Индекс документации — https://docs.happ.tools/llms.txt

Стартовый промпт:

You are integrating with the Happ Platform API.
Spec: https://api.happ.tools/api/swagger-json
Docs: https://docs.happ.tools/llms.txt
Auth: send the header X-Access-Token: happ_...
Task: <describe what you want to build>

Дальше

• Чаты — инбокс, с которым работают эти эндпоинты
• Вебхуки — отправляйте события на ваш сервер