API Reference

Happ exposes a REST + WebSocket API for managing assistants, sending messages, controlling AI mode, and integrating Happ into your workflows. The full, testable reference lives in Scalar — it is the source of truth for every endpoint, schema, and example.

api.happ.tools/reference

Resource groups

The public reference covers these groups:

• Auth — sign in, refresh a token
• Companies — workspaces, members, invitations
• Access Tokens — long-lived tokens for integrations
• Assistants — GET/POST /api/assistants-new, PATCH /api/assistants-new/{id}
• Assistant tools — /api/assistant-tools-new
• Assistant knowledge — /api/assistant-knowledge-new
• Chats — list chats, send and list messages, toggle AI control (PATCH /api/chats/{id} isUnderAiControl)
• Calls — start an outbound call: POST /api/assistants/{id}/originate

Everything else in the platform (phones, integrations, billing, analytics) is driven from the dashboard, not from the public API.

Authentication

All requests require an Access Token generated in account settings at my.happ.tools. Send it in the header:

X-Access-Token: happ_your_token_here

Base URL (production): https://api.happ.tools.

WebSocket

Connect over Socket.IO to wss://api.happ.tools (default namespace, no path suffix): authenticate with your token, pass auth: { companyId }, then receive MESSAGE_CREATED, CHAT_MODE_CHANGED, and CHAT_CREATED events. See Chats > Real-Time Updates.

Use with AI

Integrating with an AI assistant (Claude, Cursor, Copilot)? Hand it our machine-readable sources instead of copy-pasting docs:

• OpenAPI spec — https://api.happ.tools/api/swagger-json (every endpoint, schema, and auth rule)
• Docs index — https://docs.happ.tools/llms.txt

Starter prompt:

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>

Next

• Chats — the inbox these endpoints drive
• Webhooks — push events to your server