# Довідник API

REST + WebSocket API для асистентів, чатів, знань, інструментів, телефонів і вебхуків

> Full REST + WebSocket API reference: https://api.happ.tools/reference

Happ надає REST + WebSocket API для керування асистентами, надсилання повідомлень, контролю режиму AI та інтеграції Happ у ваші робочі процеси. Повний, придатний для тестування довідник живе в Scalar — він є джерелом істини для кожного ендпоінта, схеми й прикладу.

**[api.happ.tools/reference](https://api.happ.tools/reference)**

## Групи ресурсів [#групи-ресурсів]

Публічний 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.

## Автентифікація [#автентифікація]

Усі запити вимагають **токен доступу**, згенерований у налаштуваннях акаунта на [my.happ.tools](https://my.happ.tools). Надсилайте його в заголовку:

```
X-Access-Token: happ_your_token_here
```

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

## WebSocket [#websocket]

Підключення через Socket.IO до `wss://api.happ.tools` (простір імен за замовчуванням, без суфікса шляху): автентифікуйтеся токеном, передайте `auth: { companyId }` і отримуйте події `MESSAGE_CREATED`, `CHAT_MODE_CHANGED` та `CHAT_CREATED`. Див. [Чати > Оновлення в реальному часі](/docs/workspace/chats).

## Використання з AI [#використання-з-ai]

Інтегруєтесь за допомогою AI-асистента (Claude, Cursor, Copilot)? Передайте йому наші машиночитані джерела замість копіювання документації:

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

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

```text
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>
```

## Далі [#далі]

* [Чати](/docs/workspace/chats) — скринька, яку керують ці ендпоінти
* [Вебхуки](/docs/integrations/webhooks) — надсилайте події на ваш сервер