Models

Update an Audio Voice

Renames a voice that your workspace owns, instant or professional. Today name is the only field you can change. The name follows the same rules as when the voice was created: spaces at the start and end are removed, and an instant voice name can have 1 to 64 characters, a professional voice name 1 to 256. Returns the updated voice, in the same shape as GET /v3/models/audio/voices/. The HeyGen app also shows the new name. It may cut a name longer than 64 characters. A professional voice can be renamed in any status. An instant voice cannot be renamed while its status is PENDING, which lasts a few seconds after it is created: this returns 409 voice_not_ready, so wait a few seconds and try again. A public voice, a deleted voice, or a voice from another workspace returns 404 voice_not_found. A workspace member who cannot edit the voice in the HeyGen app is refused as DELETE refuses them: 403 resource_access_denied, or 404 resource_not_found when the member has no access to the voice at all.

PATCH

models

audio

voices

{voice_id}

Update an Audio Voice

curl --request PATCH \
  --url https://api.heygen.com/v3/models/audio/voices/{voice_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Support Narrator"
}
'

import requests

url = "https://api.heygen.com/v3/models/audio/voices/{voice_id}"

payload = { "name": "Support Narrator" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Support Narrator'})
};

fetch('https://api.heygen.com/v3/models/audio/voices/{voice_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/models/audio/voices/{voice_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Support Narrator'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heygen.com/v3/models/audio/voices/{voice_id}"

	payload := strings.NewReader("{\n  \"name\": \"Support Narrator\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.heygen.com/v3/models/audio/voices/{voice_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support Narrator\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/models/audio/voices/{voice_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Support Narrator\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "voice_id": "<string>",
    "mode": "professional",
    "name": "<string>",
    "status": "PENDING",
    "created_at": 123,
    "language": "<string>",
    "failure_reason": "INVALID_AUDIO",
    "preview_audio_url": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

voice_id

string

required

Unique voice identifier

Body

application/json

The fields to change on one audio voice. Only name can change today.

name

string

required

New display name of the voice. Spaces at the start and end are removed. The limits are the same as when the voice was created: 1 to 64 characters for an instant voice, 1 to 256 for a professional voice.

Required string length: 1 - 256

Example:

"Support Narrator"

Response

Successful response

data

ModelAudioVoiceResponse · object

Customer-visible state of one model-backed audio voice.

Show child attributes

⌘I

Update an Audio Voice

curl --request PATCH \
  --url https://api.heygen.com/v3/models/audio/voices/{voice_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "Support Narrator"
}
'

import requests

url = "https://api.heygen.com/v3/models/audio/voices/{voice_id}"

payload = { "name": "Support Narrator" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Support Narrator'})
};

fetch('https://api.heygen.com/v3/models/audio/voices/{voice_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/models/audio/voices/{voice_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Support Narrator'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heygen.com/v3/models/audio/voices/{voice_id}"

	payload := strings.NewReader("{\n  \"name\": \"Support Narrator\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.heygen.com/v3/models/audio/voices/{voice_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support Narrator\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/models/audio/voices/{voice_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Support Narrator\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "voice_id": "<string>",
    "mode": "professional",
    "name": "<string>",
    "status": "PENDING",
    "created_at": 123,
    "language": "<string>",
    "failure_reason": "INVALID_AUDIO",
    "preview_audio_url": "<string>"
  }
}

Video Agent

Brand

Avatars

Audio

Voices

Models

Videos

Templates

Video Translate

Lipsync

HyperFrames

User

API Keys

Webhooks

Folders

Assets

AI Clipping

Filler Word Removal

Batches

Video Translation Batches

Lipsync Batches

Asset Batches

Update an Audio Voice

Authorizations

Path Parameters

Body

Response