Skip to main content
POST
/
voices
/
v1
/
workspaces
/
{workspace}
/
voices:clone
Clone a voice
curl --request POST \
  --url https://api.inworld.ai/voices/v1/workspaces/{workspace}/voices:clone \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "langCode": "EN_US",
  "voiceSamples": [
    {
      "audioData": "aSDinaTvuI8gbWludGxpZnk=",
      "transcription": "<string>"
    }
  ],
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "audioProcessingConfig": {
    "removeBackgroundNoise": true
  }
}
'
{
  "voice": {
    "langCode": "EN_US",
    "displayName": "<string>",
    "name": "<string>",
    "description": "<string>",
    "tags": [
      "<string>"
    ],
    "voiceId": "<string>"
  },
  "audioSamplesValidated": [
    {
      "langCode": "EN_US",
      "warnings": [
        {
          "text": "<string>"
        }
      ],
      "errors": [
        {
          "text": "<string>"
        }
      ],
      "transcription": "<string>",
      "audioData": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authorizations

Authorization
string
header
required

Your API key. Make sure your API key has write permissions for the Voice API.

For Basic authentication, please populate Basic $INWORLD_BASE64_CREDENTIAL

Path Parameters

workspace
string
required

Workspace ID

Body

application/json

Request message for CloneVoice custom method.

displayName
string
required

The human-readable name shown anywhere the voice is listed or selected. Keep it short and distinctive so users can find it easily.

langCode
enum<string>
required
Available options:
EN_US,
ZH_CN,
KO_KR,
JA_JP,
RU_RU,
AUTO,
IT_IT,
ES_ES,
PT_BR,
DE_DE,
FR_FR,
AR_SA,
PL_PL,
NL_NL,
HI_IN,
HE_IL
voiceSamples
object[]
required

Voice samples used for cloning. For best results, provide clear audio and avoid speaking in multiple languages, whispering, or making non-verbal sounds like coughing. Instant voice cloning works best with a 10-15 sec audio clip; longer clips will be cutoff at 15sec, which can affect quality. See Voice Cloning Best Practices for guidance on how to generate a high-quality voice clone.

description
string

Longer blurb that explains the voice’s tone, accent, use cases, or other relevant attributes. Helpful for search and selection.

tags
string[]

Flat list of labels used for filtering, grouping and discovery. Examples could include gender, age or use case.

audioProcessingConfig
object

Audio processing config for voice cloning.

Response

A successful response.

Response message for CloneVoice custom method.

voice
object

Voice resource representing a voice configuration.

audioSamplesValidated
object[]

The list of validated samples.