BreezeDocs
Get API key

Introduction

Breeze Developer API exposes the same voice and TTS engine that powers Breeze Studio over a versioned /v1/* HTTP contract. Call it through the official Python or TypeScript SDK, or hit the endpoints directly with any HTTP client.

Start building with Breeze

Create an API key and call /v1/* in minutes.

Get API key

What you get

  • A versioned /v1/* HTTP API with binary audio responses and JSON metadata.
  • voices, text-to-speech, voice-previews, and history resources, with streaming and history audio download.
  • Official Python and TypeScript SDKs that wrap every supported endpoint.
  • Developer keys, usage metering, and request logs for API calls, with saved voices and credits shared across Breeze Studio and the Developer API.
  • A web console for managing keys, monitoring usage, and inspecting request logs.

Send your first request

The fastest path is the SDK. Install breeze-blue or @breeze.blue/sdk, export BREEZE_API_KEY, and call text_to_speech.convert. If you prefer raw HTTP, the cURL tab below works against the same endpoint.

python import os from pathlib import Path from breeze_blue import BreezeBlue, save client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"]) audio = client.text_to_speech.convert( voice_id="voc_xeh3w54cqvnp", text="Hello from Breeze", output_format="mp3", ) save(audio, Path("out.mp3")) typescript import { BreezeBlueClient } from "@breeze.blue/sdk"; import { save } from "@breeze.blue/sdk/node"; const client = new BreezeBlueClient({ apiKey: process.env.BREEZE_API_KEY!, }); const audio = await client.textToSpeech.convert( "voc_xeh3w54cqvnp", { text: "Hello from Breeze" }, { outputFormat: "mp3" }, ); await save(audio, "out.mp3"); curl curl -X POST "https://api.breeze.blue/v1/text-to-speech/voc_xeh3w54cqvnp?output_format=mp3" \ -H "xi-api-key: $BREEZE_API_KEY" \ -H "content-type: application/json" \ -d '{ "text": "Hello from Breeze" }' \ --output out.mp3
import os
from pathlib import Path

from breeze_blue import BreezeBlue, save

client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])

audio = client.text_to_speech.convert(
    voice_id="voc_xeh3w54cqvnp",
    text="Hello from Breeze",
    output_format="mp3",
)

save(audio, Path("out.mp3"))

Where to go next