API (Swagger)

Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

An interactive **Swagger UI** explorer for the entire AiHummer HTTP API. Every endpoint of your instance is here: the OpenAI-compatible chat surface (`POST /v1/chat/completions`), inbound messages and triggers, device pairing, SSO/SCIM provisioning, and the complete admin API — managing agents, knowledge, analytics, modules and security. <p style="margin:1.5rem 0;"> <a href="/api/" style="display:inline-block;padding:0.85rem 1.5rem;border-radius:10px;background:#F0632E;color:#1a0d08;font-weight:600;text-decoration:none;"> Open Swagger UI → </a> </p> ## Authentication Requests are authenticated with an AiHummer API key (prefixed `ah-`) sent as a Bearer token: ```http Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` Keys are issued from the web admin UI. In Swagger UI, click **Authorize** and paste a key to run live "Try it out" requests from your browser. ## Server The spec ships with a `https://your-instance.example.com` placeholder — pick your instance address from the servers dropdown or replace it with your own (in production TLS is terminated at a reverse proxy in front of the gateway). > [!TIP] > The machine-readable spec is available at [`/openapi.json`](/openapi.json) and > imports cleanly into Postman, Insomnia or editor.swagger.io. ## Where to next - The chat endpoint in detail: [Chat Completions API](/en/v1.0/api/chat-completions). - Inbound messages and triggers: [Inbound & triggers](/en/v1.0/api/inbound-triggers). - Pairing, SSO and protocols: [Webhooks, SCIM & pairing](/en/v1.0/api/webhooks-scim-pairing).