GET
https://api.breeze.blue/v1/voice-previews/{generated_voice_id}/streamStream voice preview
Download a previously generated voice preview before saving it.
Authentication
API key: Send your Breeze Developer API key with the xi-api-key header.
Headers
| Field | Type | Description |
|---|---|---|
xi-api-keyrequired | string | Your Breeze Developer API key. See authentication. |
Path parameters
| Field | Type | Description |
|---|---|---|
generated_voice_idrequired | string | Preview ID returned by POST /v1/voice-previews/design or POST /v1/voice-previews/clone. |
Query parameters
| Field | Type | Description |
|---|---|---|
output_format | stringdefault: mp3 | Output format for the preview. Supported values: mp3, wav, flac, pcm, aac, opus. Default: mp3. |
Example request
python
from pathlib import Path
from breeze_blue import save
import os
from breeze_blue import BreezeBlue
client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])
audio = client.voices.stream_preview(
generated_voice_id="gvi_01hpreview",
)
save(audio, Path("preview.mp3"))
typescript
import { save } 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.streamPreview(
"gvi_01hpreview",
);
await save(audio, "preview.mp3");
curl
curl "https://api.breeze.blue/v1/voice-previews/gvi_01hpreview/stream" \
-H "xi-api-key: $BREEZE_API_KEY"
from pathlib import Path
from breeze_blue import save
import os
from breeze_blue import BreezeBlue
client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])
audio = client.voices.stream_preview(
generated_voice_id="gvi_01hpreview",
)
save(audio, Path("preview.mp3"))Response
Binary audio preview.
Content types: audio/mpeg, audio/wav, audio/flac, audio/aac, audio/opus, audio/pcm
Response headers:
x-breeze-api-key-id: Public API key identifier used to authenticate the request, when an API key was used.
Binary audio/mpeg, audio/wav, audio/flac, audio/aac, audio/opus, audio/pcm response bodyErrors
RESOURCE_NOT_FOUND— The generated voice preview does not exist or is not accessible.
See the full list on errors.