# API conventions

> Base URL, auth, errors, ids and timing that apply to every endpoint, and an index of the endpoint groups.

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

Base URL: `https://api.whabuzz.com`. All bodies are JSON unless stated. The [interactive reference](https://docs.whabuzz.com/reference.md) is rendered from the [OpenAPI 3.1 file](https://docs.whabuzz.com/openapi.yaml) ([JSON](https://docs.whabuzz.com/openapi.json)), so it cannot drift from the contract.

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