GET
https://api.breeze.blue/v1/generation-jobs/{generation_job_id}/audioDownload generation job audio
Download the audio for a completed asynchronous text-to-speech job.
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 |
|---|---|---|
generation_job_idrequired | string | Generation job identifier returned by async text-to-speech. |
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.generation_jobs.download_audio("job_01hasync")
save(audio, Path("async.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.generationJobs.downloadAudio("job_01hasync");
await save(audio, "async.mp3");
curl
curl "https://api.breeze.blue/v1/generation-jobs/job_01hasync/audio" \
-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.generation_jobs.download_audio("job_01hasync")
save(audio, Path("async.mp3"))Response
Generated audio bytes.
Content types: audio/mpeg, audio/wav, audio/flac, audio/aac, audio/opus, audio/pcm
Response headers:
content-disposition: Suggested inline filename.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
GENERATION_NOT_READY— The generation job is still running; retry after the Retry-After interval.GENERATION_FAILED— The generation job failed.RESOURCE_NOT_FOUND— The generation job or audio does not exist or is not accessible.
See the full list on errors.