# API reference

The supported public endpoints, required scopes, response envelope, and format conventions.

## Base URL

All requests use HTTPS. Send Bearer authentication for every endpoint. JSON requests require Content-Type: application/json; send operations also require Idempotency-Key. These are server-to-server APIs; do not expose keys in browser applications.







```url
https://turbinewhats.app/api/v1
```





## Supported endpoints

The catalog below describes the public v1 surface. Workspace-only configuration endpoints use browser authentication and are not presented as a public API.













## Response conventions

Successful responses use a data envelope. Creating a session returns HTTP 200 and a queued state. Queuing a message returns HTTP 202; that status also applies when an idempotent replay returns an existing message state.

Errors use an error envelope with code and message. Session and message IDs are TurbineWhats.app UUIDs. Times are serialized as ISO date-time strings. Request field names use snake_case; the gateway-derived QR response uses qrCode and status.











[Errors](https://turbinewhats.app/docs/errors)
[Authentication](https://turbinewhats.app/docs/authentication)