# Breeze Blue

> Reference documentation, guides, and quickstarts for the Breeze Developer API, SDKs, and CLI.

## Docs

- [Create an API key](https://docs.breezeblue.ai/api-reference/account/create-an-api-key.md): Create an API key and return the one-time secret.
- [Delete an API key](https://docs.breezeblue.ai/api-reference/account/delete-an-api-key.md): Delete an API key. Historical usage records are retained.
- [Disable an API key](https://docs.breezeblue.ai/api-reference/account/disable-an-api-key.md): Disable an API key without deleting it.
- [Enable an API key](https://docs.breezeblue.ai/api-reference/account/enable-an-api-key.md): Re-enable a disabled API key.
- [Get account balance](https://docs.breezeblue.ai/api-reference/account/get-account-balance.md): Get the current credit balance and recent top-ups.
- [Get account entitlements](https://docs.breezeblue.ai/api-reference/account/get-account-entitlements.md): Get the current plan code and generation concurrency limits.
- [Get usage metering](https://docs.breezeblue.ai/api-reference/account/get-usage-metering.md): Get aggregated usage with daily buckets and recent requests.
- [List API keys](https://docs.breezeblue.ai/api-reference/account/list-api-keys.md): List API keys for the signed-in user. API keys are not accepted on this endpoint.
- [Rename an API key](https://docs.breezeblue.ai/api-reference/account/rename-an-api-key.md): Rename an API key.
- [Rotate an API key](https://docs.breezeblue.ai/api-reference/account/rotate-an-api-key.md): Create a replacement API key and mark the source key as expiring. The replacement secret is returned once.
- [Delete a history item](https://docs.breezeblue.ai/api-reference/history/delete-a-history-item.md): Soft-delete a history item.
- [Download history audio](https://docs.breezeblue.ai/api-reference/history/download-history-audio.md): Download the audio for a completed history item.
- [Get a history item](https://docs.breezeblue.ai/api-reference/history/get-a-history-item.md): Get a history item by ID.
- [List history items](https://docs.breezeblue.ai/api-reference/history/list-history-items.md): List text-to-speech history items.
- [API reference introduction](https://docs.breezeblue.ai/api-reference/introduction.md): Base URL, authentication, content types, and conventions for the Breeze Developer API.
- [List models](https://docs.breezeblue.ai/api-reference/models/list-models.md): List available TTS models.
- [AI rewrite text to speech instruction](https://docs.breezeblue.ai/api-reference/text-to-speech/ai-rewrite-text-to-speech-instruction.md): Rewrite a user-provided TTS instruction into clearer model guidance without changing the script.
- [Convert text to speech](https://docs.breezeblue.ai/api-reference/text-to-speech/convert-text-to-speech.md): Synthesize text to audio using the given voice.
- [Download generation job audio](https://docs.breezeblue.ai/api-reference/text-to-speech/download-generation-job-audio.md): Download the audio for a completed asynchronous text-to-speech job.
- [Get generation job](https://docs.breezeblue.ai/api-reference/text-to-speech/get-generation-job.md): Get the status and result metadata for an asynchronous text-to-speech job.
- [Stream text to speech](https://docs.breezeblue.ai/api-reference/text-to-speech/stream-text-to-speech.md): Stream synthesized audio as it is generated.
- [Create clone preview](https://docs.breezeblue.ai/api-reference/voice-previews/create-clone-preview.md): Upload one reference sample and create a temporary voice clone preview.
- [Create design previews](https://docs.breezeblue.ai/api-reference/voice-previews/create-design-previews.md): Generate temporary voice previews from a text description.
- [Save voice preview](https://docs.breezeblue.ai/api-reference/voice-previews/save-voice-preview.md): Save a generated preview as a private voice.
- [Stream voice preview](https://docs.breezeblue.ai/api-reference/voice-previews/stream-voice-preview.md): Download a previously generated voice preview before saving it.
- [Delete a voice](https://docs.breezeblue.ai/api-reference/voices/delete-a-voice.md): Soft-delete a saved voice.
- [Edit a voice](https://docs.breezeblue.ai/api-reference/voices/edit-a-voice.md): Update a saved voice. Optionally replace the reference sample.
- [Get a random voice](https://docs.breezeblue.ai/api-reference/voices/get-a-random-voice.md): Return one random voice visible to the authenticated user. Use the returned voice_id with text-to-speech endpoints.
- [Get a voice](https://docs.breezeblue.ai/api-reference/voices/get-a-voice.md): Get voice metadata by voice_id.
- [Get voice settings](https://docs.breezeblue.ai/api-reference/voices/get-voice-settings.md): Get saved voice_settings for a voice.
- [List voices](https://docs.breezeblue.ai/api-reference/voices/list-voices.md): List premade and developer-owned voices.
- [Update voice settings](https://docs.breezeblue.ai/api-reference/voices/update-voice-settings.md): Update voice_settings. At least one field is required.
- [Authentication](https://docs.breezeblue.ai/authentication.md): Authenticate with xi-api-key or Authorization Bearer.
- [Breeze CLI](https://docs.breezeblue.ai/cli/index.md): Install Breeze CLI, log in, generate audio, automate agent workflows, and turn CLI commands into API requests.
- [Breeze CLI quickstart](https://docs.breezeblue.ai/cli/quickstart.md): Install Breeze CLI, log in with your Breeze account, and generate your first audio.
- [Breeze CLI auth](https://docs.breezeblue.ai/cli/reference/auth.md): Log in, log out, and manage Breeze CLI credentials.
- [Breeze CLI config and update](https://docs.breezeblue.ai/cli/reference/config-update.md): Manage Breeze CLI profiles, local credentials, and update preferences.
- [Breeze CLI reference](https://docs.breezeblue.ai/cli/reference/index.md): Breeze CLI command overview for audio generation, auth, config, updates, Video Lab automation, and agent scripting.
- [Breeze CLI scripting and agents](https://docs.breezeblue.ai/cli/reference/scripting.md): Run Breeze CLI from scripts and AI agents: --agent JSON output, exit codes, capabilities discovery, and skill install.
- [Breeze CLI troubleshooting](https://docs.breezeblue.ai/cli/reference/troubleshooting.md): Fix common Breeze CLI install, login, update, and Video Lab issues.
- [Breeze CLI text to speech](https://docs.breezeblue.ai/cli/reference/tts.md): Generate audio with Breeze CLI text-to-speech commands.
- [Breeze CLI Video Lab](https://docs.breezeblue.ai/cli/reference/video-lab.md): Use Breeze Video Lab from agent and automation environments.
- [Output formats](https://docs.breezeblue.ai/concepts/output-format.md): Audio codec, sample rate, and bitrate options for text to speech.
- [Pricing](https://docs.breezeblue.ai/concepts/pricing.md): How Breeze meters and bills Developer API requests.
- [Streaming](https://docs.breezeblue.ai/concepts/streaming.md): Low-latency streaming text to speech.
- [Voices](https://docs.breezeblue.ai/concepts/voices.md): Understand voice_id, the public catalog, and voice_settings.
- [Managing history](https://docs.breezeblue.ai/guides/managing-history.md): List, replay, and delete past text-to-speech requests.
- [Text to speech](https://docs.breezeblue.ai/guides/text-to-speech.md): Convert text to audio with one-shot, streaming, and async requests.
- [Cloning a voice](https://docs.breezeblue.ai/guides/voice-clone.md): Clone a voice from an audio sample.
- [Designing a voice](https://docs.breezeblue.ai/guides/voice-design.md): Generate a voice from a text prompt.
- [Introduction](https://docs.breezeblue.ai/index.md): Build voice and text-to-speech experiences with the Breeze Developer API, SDKs, and CLI.
- [SDK quickstart](https://docs.breezeblue.ai/quickstart.md): Install the Python or TypeScript SDK, create an API key, and synthesize audio.
- [Errors](https://docs.breezeblue.ai/reference/errors.md): Error codes with HTTP status, domain, and retry guidance.
- [Rate limits](https://docs.breezeblue.ai/reference/rate-limits.md): Concurrent generation limits for Breeze API plans.

## OpenAPI Specs

- [openapi](https://docs.breezeblue.ai/openapi.json)