Introduction

The Breeze Developer API is a versioned HTTP API at https://api.breeze.blue. All endpoints sit under /v1/* and return JSON or binary audio.

Base URL

text https://api.breeze.blue/v1
https://api.breeze.blue/v1

Authentication

Most endpoints accept an API key via the xi-api-key header. Account management endpoints (e.g. /v1/api-keys) require a browser session instead. See authentication for details.

http xi-api-key: brz_xxxxxxxxxxxxxxxx
xi-api-key: brz_xxxxxxxxxxxxxxxx

Content type

JSON requests use content-type: application/json. Voice cloning uses multipart/form-data. Audio responses are raw binary.

Errors

Errors return ok: false, a code string, a detail message, and an error field mirroring detail. Validation errors may include a meta object. See errors.

Rate limits

Breeze does not publish a public rate-limit contract yet. See rate limits.