# API reference

> Base URL, conventions and an index of every endpoint group.

Canonical: https://docs.whabuzz.com/api/

Base URL: `https://api.whabuzz.com`. All bodies are JSON unless stated. The contract is generated from the [OpenAPI 3.1 file](https://docs.whabuzz.com/openapi.yaml) ([JSON](https://docs.whabuzz.com/openapi.json)); these pages are generated from the same file, so they cannot drift.

## Conventions {#conventions}

- **Auth.** `Authorization: Bearer <key>`. See [Authentication](https://docs.whabuzz.com/authentication.md). Platform keys add `X-WhaBuzz-Tenant`.
- **Meta bodies are Meta's.** Message, template and media endpoints take and return Meta's shapes; the reference shows examples and links to Meta for the full field list.
- **Errors.** `{"source":"whabuzz"|"meta", …}`. See [Errors](https://docs.whabuzz.com/errors.md).
- **Ids.** `req_` request, `evt_` event, `dlv_` delivery, `bat_` batch; others are UUIDs or Meta's ids.
- **Timing.** Every response has `Server-Timing` and `X-WhaBuzz-Processing-Ms`.
- **Version.** `2026-10-16`.

## Endpoint groups {#groups}

- [Health](https://docs.whabuzz.com/api/health.md): unauthenticated liveness.
- [Tenant (your account)](https://docs.whabuzz.com/api/tenant.md) and [Tenants](https://docs.whabuzz.com/api/tenants.md) for platforms.
- [API keys](https://docs.whabuzz.com/api/api-keys.md)
- [Numbers](https://docs.whabuzz.com/api/numbers.md) and [Connect sessions](https://docs.whabuzz.com/api/connect-sessions.md)
- [Messages](https://docs.whabuzz.com/api/messages.md), including batches
- [Media](https://docs.whabuzz.com/api/media.md)
- [Templates](https://docs.whabuzz.com/api/templates.md)
- [Webhooks](https://docs.whabuzz.com/api/webhooks.md) and deliveries
- [Event log](https://docs.whabuzz.com/api/events.md)
- [Billing](https://docs.whabuzz.com/api/billing.md)
- [Admin](https://docs.whabuzz.com/api/admin.md): WhaBuzz staff only; documented for completeness.