cURL
curl \
--request POST \
--url "https://api.breeze.blue/v1/voice-previews/design/stream" \
--header "xi-api-key: $BREEZE_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"voice_description": "Warm, intimate narrator with crisp diction.",
"text": "Welcome to Breeze Blue.",
"language_code": "en",
"guidance_scale": 4.0
}'from breeze_blue import stream
import os
from breeze_blue import BreezeBlue
client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])
audio = client.voices.stream_design_preview(
voice_description="Warm, intimate narrator with crisp diction.",
text="Welcome to Breeze Blue.",
guidance_scale=4.0,
)
print(audio.generated_voice_id)
stream(audio)import { stream } from "@breeze.blue/sdk/node";
import { BreezeBlueClient } from "@breeze.blue/sdk";
const client = new BreezeBlueClient({
apiKey: process.env.BREEZE_API_KEY!,
});
const audio = await client.voices.streamDesignPreview({
voiceDescription: "Warm, intimate narrator with crisp diction.",
text: "Welcome to Breeze Blue.",
guidanceScale: 4.0,
});
console.log(audio.generatedVoiceId);
await stream(audio);"<string>"{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}Voice Previews
Stream a design preview
Generate one temporary voice preview and stream its audio while it is being created.
POST
/
v1
/
voice-previews
/
design
/
stream
cURL
curl \
--request POST \
--url "https://api.breeze.blue/v1/voice-previews/design/stream" \
--header "xi-api-key: $BREEZE_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"voice_description": "Warm, intimate narrator with crisp diction.",
"text": "Welcome to Breeze Blue.",
"language_code": "en",
"guidance_scale": 4.0
}'from breeze_blue import stream
import os
from breeze_blue import BreezeBlue
client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])
audio = client.voices.stream_design_preview(
voice_description="Warm, intimate narrator with crisp diction.",
text="Welcome to Breeze Blue.",
guidance_scale=4.0,
)
print(audio.generated_voice_id)
stream(audio)import { stream } from "@breeze.blue/sdk/node";
import { BreezeBlueClient } from "@breeze.blue/sdk";
const client = new BreezeBlueClient({
apiKey: process.env.BREEZE_API_KEY!,
});
const audio = await client.voices.streamDesignPreview({
voiceDescription: "Warm, intimate narrator with crisp diction.",
text: "Welcome to Breeze Blue.",
guidanceScale: 4.0,
});
console.log(audio.generatedVoiceId);
await stream(audio);"<string>"{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}{
"code": "<string>",
"detail": "<string>",
"error": "<string>",
"ok": false,
"meta": {}
}Authorizations
Breeze Developer API key.
Body
application/json
Single-preview request contract for live PCM voice design audio.
Text description of the desired voice.
Required string length:
3 - 500Preview script. Breeze uses a default script when omitted.
Required string length:
3 - 500Optional model identifier to use for generation.
Required string length:
1 - 120Optional ISO 639-1 two-letter preview language.
Required string length:
2Pattern:
^[A-Za-z]{2}$Optional generation guidance strength for preview generation. Accepted range: 1.0 to 10.0. When provided, that exact value is used; when omitted, Breeze picks a random value between 1.0 and 10.0 for the request.
Required range:
1 <= x <= 10Response
Live 24 kHz mono signed 16-bit little-endian PCM audio. A clean EOF means the preview is persisted and can be saved.
The response is of type file.

