# Breeze Blue

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

## Docs

- [List models](https://breezeblue-pre.mintlify.site/api-reference/models/list-models.md): List TTS models available to the authenticated account. Each model includes a human-readable description and the ISO 639-1 language codes accepted by that model.
- [Convert text to speech](https://breezeblue-pre.mintlify.site/api-reference/text-to-speech/convert-text-to-speech.md): Synthesize text to audio using the given voice.
- [Get generation job](https://breezeblue-pre.mintlify.site/api-reference/text-to-speech/get-generation-job.md): Get the status and result metadata for an asynchronous text-to-speech job.
- [Download generation job audio](https://breezeblue-pre.mintlify.site/api-reference/text-to-speech/download-generation-job-audio.md): Download the audio for a completed asynchronous text-to-speech job.
- [Stream text to speech](https://breezeblue-pre.mintlify.site/api-reference/text-to-speech/stream-text-to-speech.md): Stream synthesized audio as it is generated.
- [Create realtime TTS session](https://breezeblue-pre.mintlify.site/api-reference/text-to-speech/create-realtime-tts-session.md): Create a short-lived browser-safe token for the realtime text-to-speech WebSocket. This HTTP operation only creates the session. Official SDKs and the CLI prefer the optional query-free `direct_websocket_url` and fall back to `websocket_url`; wait for `session.ready`, and then exchange turn events a…
- [Enhance text to speech instruction](https://breezeblue-pre.mintlify.site/api-reference/text-to-speech/enhance-text-to-speech-instruction.md): Enhance a user-provided TTS instruction into clearer model guidance without changing the script or translating the instruction.
- [List Voice Metadata options](https://breezeblue-pre.mintlify.site/api-reference/voices/list-voice-metadata-options.md): Return the stable code sets accepted by Voice Metadata fields, including the complete language_code enum, the tone limit, and the language-to-accent cascade. Values are stable codes rather than localized display text.
- [List voices](https://breezeblue-pre.mintlify.site/api-reference/voices/list-voices.md): List or search every voice available to the authenticated account. Search combines semantic relevance with exact and partial text matching.
- [Get a random voice](https://breezeblue-pre.mintlify.site/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://breezeblue-pre.mintlify.site/api-reference/voices/get-a-voice.md): Get voice metadata by voice_id.
- [Delete a voice](https://breezeblue-pre.mintlify.site/api-reference/voices/delete-a-voice.md): Soft-delete a saved voice.
- [Edit a voice](https://breezeblue-pre.mintlify.site/api-reference/voices/edit-a-voice.md): Update a saved voice. Metadata values are stable lowercase codes. Omit a metadata field to preserve it; send an empty string to clear gender, age, or accent, and send one empty tone field to clear tone. When language_code changes and the existing accent is no longer valid, Breeze clears accent autom…
- [Update effective voice tags](https://breezeblue-pre.mintlify.site/api-reference/voices/update-effective-voice-tags.md): Replace owner tags or a favoriting account's complete personal override. An empty personal array resumes inheritance from the owner.
- [Favorite a voice](https://breezeblue-pre.mintlify.site/api-reference/voices/favorite-a-voice.md): Create or reactivate the authenticated account's favorite relation.
- [Unfavorite a voice](https://breezeblue-pre.mintlify.site/api-reference/voices/unfavorite-a-voice.md): Soft-delete the favorite relation while retaining its personal tag override.
- [Get voice settings](https://breezeblue-pre.mintlify.site/api-reference/voices/get-voice-settings.md): Get saved voice_settings for a voice.
- [Update voice settings](https://breezeblue-pre.mintlify.site/api-reference/voices/update-voice-settings.md): Update voice_settings. At least one field is required.
- [Create clone preview](https://breezeblue-pre.mintlify.site/api-reference/voice-previews/create-clone-preview.md): Upload one reference sample and create a temporary voice clone preview.
- [Create design previews](https://breezeblue-pre.mintlify.site/api-reference/voice-previews/create-design-previews.md): Generate temporary voice previews from a text description.
- [Stream voice preview](https://breezeblue-pre.mintlify.site/api-reference/voice-previews/stream-voice-preview.md): Download a previously generated voice preview before saving it.
- [Save voice preview](https://breezeblue-pre.mintlify.site/api-reference/voice-previews/save-voice-preview.md): Save a generated preview as a private voice. Voice Metadata values are stable lowercase codes; tone accepts up to three distinct codes. language_code is required. accent is available only for en and zh and must match language_code.
- [Get account balance](https://breezeblue-pre.mintlify.site/api-reference/account/get-account-balance.md): Get the current credit balance and recent top-ups.
- [Get account entitlements](https://breezeblue-pre.mintlify.site/api-reference/account/get-account-entitlements.md): Get the current plan code and generation concurrency limits.
- [Get usage metering](https://breezeblue-pre.mintlify.site/api-reference/account/get-usage-metering.md): Get aggregated usage with daily buckets and recent requests.
- [List API keys](https://breezeblue-pre.mintlify.site/api-reference/account/list-api-keys.md): List API keys for the signed-in user. API keys are not accepted on this endpoint.
- [Create an API key](https://breezeblue-pre.mintlify.site/api-reference/account/create-an-api-key.md): Create an API key and return the one-time secret.
- [Delete an API key](https://breezeblue-pre.mintlify.site/api-reference/account/delete-an-api-key.md): Delete an API key. Historical usage records are retained.
- [Update an API key](https://breezeblue-pre.mintlify.site/api-reference/account/update-an-api-key.md): Update an API key name and/or hard credit limit.
- [Disable an API key](https://breezeblue-pre.mintlify.site/api-reference/account/disable-an-api-key.md): Disable an API key without deleting it.
- [Enable an API key](https://breezeblue-pre.mintlify.site/api-reference/account/enable-an-api-key.md): Re-enable a disabled API key.
- [Rotate an API key](https://breezeblue-pre.mintlify.site/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.
- [Reset an API key credit budget](https://breezeblue-pre.mintlify.site/api-reference/account/reset-an-api-key-credit-budget.md): Start a new budget epoch and reset Used and Reserved to zero. This does not add credits to the account balance.
- [List history items](https://breezeblue-pre.mintlify.site/api-reference/history/list-history-items.md): List text-to-speech history items.
- [Get a history item](https://breezeblue-pre.mintlify.site/api-reference/history/get-a-history-item.md): Get a history item by ID.
- [Delete a history item](https://breezeblue-pre.mintlify.site/api-reference/history/delete-a-history-item.md): Soft-delete a history item.
- [Download history audio](https://breezeblue-pre.mintlify.site/api-reference/history/download-history-audio.md): Download the audio for a completed history item.
- [Breeze CLI Video Lab](https://breezeblue-pre.mintlify.site/cli/reference/video-lab.md): Use Breeze Video Lab from agent and automation environments.
- [Breeze CLI config and update](https://breezeblue-pre.mintlify.site/cli/reference/config-update.md): Manage Breeze CLI profiles, local credentials, and update preferences.

## OpenAPI Specs

- [openapi](https://breezeblue-pre.mintlify.site/openapi.json)