cURL
curl \
--request PATCH \
--url "https://api.breeze.blue/v1/voices/voc_xeh3w54cqvnp/settings" \
--header "xi-api-key: $BREEZE_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"guidance_scale": 1.4
}'import os
from breeze_blue import BreezeBlue
client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])
settings = client.voices.edit_settings(
"voc_xeh3w54cqvnp",
guidance_scale=1.4,
)
print(settings)import { BreezeBlueClient } from "@breeze.blue/sdk";
const client = new BreezeBlueClient({
apiKey: process.env.BREEZE_API_KEY!,
});
const settings = await client.voices.editSettings("voc_xeh3w54cqvnp", {
guidanceScale: 1.4,
});
console.log(settings);{
"guidance_scale": 1
}{
"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": {}
}Voices
Update voice settings
Update voice_settings. At least one field is required.
PATCH
/
v1
/
voices
/
{voice_id}
/
settings
cURL
curl \
--request PATCH \
--url "https://api.breeze.blue/v1/voices/voc_xeh3w54cqvnp/settings" \
--header "xi-api-key: $BREEZE_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"guidance_scale": 1.4
}'import os
from breeze_blue import BreezeBlue
client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])
settings = client.voices.edit_settings(
"voc_xeh3w54cqvnp",
guidance_scale=1.4,
)
print(settings)import { BreezeBlueClient } from "@breeze.blue/sdk";
const client = new BreezeBlueClient({
apiKey: process.env.BREEZE_API_KEY!,
});
const settings = await client.voices.editSettings("voc_xeh3w54cqvnp", {
guidanceScale: 1.4,
});
console.log(settings);{
"guidance_scale": 1
}{
"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": {}
}Continue building
Get voice settings
Read back the saved settings.
Convert text to speech
Try the settings on a passage.
Write instructions
Direct delivery without changing voice identity.
Authorizations
Breeze Developer API key.
Path Parameters
Voice identifier returned by GET /v1/voices. See List voices.
Body
application/json
Generation guidance strength. Accepted range: 1.0 to 10.0. See Voice settings.
Required range:
1 <= x <= 10Response
Updated voice settings.

