Create clone preview

cURL

curl \
  --request POST \
  --url "https://api.breeze.blue/v1/voice-previews/clone" \
  --header "xi-api-key: $BREEZE_API_KEY" \
  --form "name=Brand Narrator" \
  --form "description=Clean studio narration sample." \
  --form "files=@sample.wav;type=audio/wav"

from pathlib import Path

import os

from breeze_blue import BreezeBlue

client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])

preview = client.voices.create_clone_preview(
    name="Brand Narrator",
    file=Path("sample.wav"),
    description="Clean studio narration sample.",
)

print(preview["generated_voice_id"])

import { readFile } from "node:fs/promises";
import { BreezeBlueClient } from "@breeze.blue/sdk";

const client = new BreezeBlueClient({
  apiKey: process.env.BREEZE_API_KEY!,
});

const preview = await client.voices.createClonePreview({
  name: "Brand Narrator",
  file: {
    data: await readFile("sample.wav"),
    filename: "sample.wav",
    contentType: "audio/wav",
  },
  description: "Clean studio narration sample.",
});

console.log(preview.generatedVoiceId);

{
  "generated_voice_id": "<string>",
  "requires_verification": false
}

{
  "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": {}
}

POST

voice-previews

clone

cURL

curl \
  --request POST \
  --url "https://api.breeze.blue/v1/voice-previews/clone" \
  --header "xi-api-key: $BREEZE_API_KEY" \
  --form "name=Brand Narrator" \
  --form "description=Clean studio narration sample." \
  --form "files=@sample.wav;type=audio/wav"

from pathlib import Path

import os

from breeze_blue import BreezeBlue

client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])

preview = client.voices.create_clone_preview(
    name="Brand Narrator",
    file=Path("sample.wav"),
    description="Clean studio narration sample.",
)

print(preview["generated_voice_id"])

import { readFile } from "node:fs/promises";
import { BreezeBlueClient } from "@breeze.blue/sdk";

const client = new BreezeBlueClient({
  apiKey: process.env.BREEZE_API_KEY!,
});

const preview = await client.voices.createClonePreview({
  name: "Brand Narrator",
  file: {
    data: await readFile("sample.wav"),
    filename: "sample.wav",
    contentType: "audio/wav",
  },
  description: "Clean studio narration sample.",
});

console.log(preview.generatedVoiceId);

{
  "generated_voice_id": "<string>",
  "requires_verification": false
}

{
  "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

xi-api-key

string

header

required

Breeze Developer API key.

Body

multipart/form-data

name

string

required

Display name for the clone preview. Maximum 80 characters.

Maximum string length: 80

files

file[]

required

Reference audio sample. WAV or MP3, at least 3 seconds, up to 5MB. Breeze analyzes the first 60 seconds and stores up to 30 seconds of it as the reference. Exactly one file.

Required array length: 1 element

description

string | null

Description stored with the preview.

text

string | null

Preview script. Breeze uses a default script when omitted.

instructions

string | null

Performance guidance for the preview.

language_code

string | null

Reference sample language. Provide a supported ISO 639-1 two-letter code unless Breeze can detect it from the uploaded audio.

Response

Generated clone preview.

generated_voice_id

string

required

requires_verification

boolean

default:false

Overview

Models

Text to Speech

Voices

Voice Previews

Account

History

Authorizations

Body

Response