Create a voice clone from a voice design

Creates a new voice clone by capturing the voice identity of an existing voice design. The clone can then be used for text-to-speech synthesis.

POST /voice_clones

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const voiceClone = await client.voiceClones.create({
  params: {
    gender: 'male',
    language: 'en',
    name: 'clone-narrator',
    voice_design_id: '550e8400-e29b-41d4-a716-446655440000',
    provider: 'telnyx',
  },
});

console.log(voiceClone.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
voice_clone = client.voice_clones.create(
    params={
        "gender": "male",
        "language": "en",
        "name": "clone-narrator",
        "voice_design_id": "550e8400-e29b-41d4-a716-446655440000",
        "provider": "telnyx",
    },
)
print(voice_clone.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	voiceClone, err := client.VoiceClones.New(context.TODO(), telnyx.VoiceCloneNewParams{
		OfTelnyxDesignClone: &telnyx.VoiceCloneNewParamsParamsTelnyxDesignClone{
			Gender:        "male",
			Language:      "en",
			Name:          "clone-narrator",
			VoiceDesignID: "550e8400-e29b-41d4-a716-446655440000",
			Provider:      "telnyx",
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", voiceClone.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.voiceclones.VoiceCloneCreateParams;
import com.telnyx.sdk.models.voiceclones.VoiceCloneCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        VoiceCloneCreateParams.Params.TelnyxDesignClone params = VoiceCloneCreateParams.Params.TelnyxDesignClone.builder()
            .gender(VoiceCloneCreateParams.Params.TelnyxDesignClone.Gender.MALE)
            .language("en")
            .name("clone-narrator")
            .voiceDesignId("550e8400-e29b-41d4-a716-446655440000")
            .provider(VoiceCloneCreateParams.Params.TelnyxDesignClone.Provider.TELNYX)
            .build();
        VoiceCloneCreateResponse voiceClone = client.voiceClones().create(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

voice_clone = telnyx.voice_clones.create(
  params: {
    gender: :male,
    language: "en",
    name: "clone-narrator",
    voice_design_id: "550e8400-e29b-41d4-a716-446655440000",
    provider: :telnyx
  }
)

puts(voice_clone)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $voiceClone = $client->voiceClones->create(
    params: [
      'gender' => 'male',
      'language' => 'en',
      'name' => 'clone-narrator',
      'voiceDesignID' => '550e8400-e29b-41d4-a716-446655440000',
      'provider' => 'telnyx',
    ],
  );

  var_dump($voiceClone);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx voice-clones create \
  --api-key 'My API Key' \
  --params '{gender: male, language: en, name: clone-narrator, voice_design_id: 550e8400-e29b-41d4-a716-446655440000, provider: telnyx}'

curl --request POST \
  --url https://api.telnyx.com/v2/voice_clones \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "clone-narrator",
  "voice_design_id": "550e8400-e29b-41d4-a716-446655440000",
  "language": "en",
  "gender": "male",
  "provider": "telnyx"
}
'

201

{
  "data": {
    "record_type": "voice_clone",
    "id": "660f9511-f3ac-52e5-b827-557766551111",
    "source_voice_design_id": "550e8400-e29b-41d4-a716-446655440000",
    "source_voice_design_version": 1,
    "name": "clone-narrator",
    "language": "en",
    "gender": "male",
    "label": "Speak in a warm, friendly tone",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "provider": "Telnyx",
    "provider_supported_models": [
      "Qwen3TTS"
    ],
    "provider_voice_id": "660f9511-f3ac-52e5-b827-557766551111",
    "model_id": "Qwen3TTS",
    "status": "active"
  }
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "Voice design not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "Voice design not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "Voice design not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "Voice design not found"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Option 1

Option 2

Request body for creating a voice clone from an existing voice design.

name · string · required

Name for the voice clone.

Required string length: 1 - 255

voice_design_id · string<uuid> · required

UUID of the source voice design to clone.

language · string · required

ISO 639-1 language code for the clone. Supports the combined Telnyx language set.

gender · enum<string> · required

Gender of the voice clone.

Available options: male, female, neutral

provider · enum<string> · default: telnyx

Voice synthesis provider. Defaults to telnyx.

Available options: telnyx, Telnyx

Response

201

application/json

Voice clone created successfully.

Response envelope for a single voice clone.

data · object

A voice clone object.

Show child attributes