Update a voice

PATCH /v1/accounts/{accountId}/voice-library/{voiceId}

Update a voice in the voice library

cURL

curl --request PATCH \
  --url https://api.us.poly.ai/v1/accounts/{accountId}/voice-library/{voiceId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "provider": "<string>",
  "config": {},
  "providerVoiceId": "<string>",
  "voiceMetadata": {}
}
'

import requests

url = "https://api.us.poly.ai/v1/accounts/{accountId}/voice-library/{voiceId}"

payload = {
    "name": "<string>",
    "provider": "<string>",
    "config": {},
    "providerVoiceId": "<string>",
    "voiceMetadata": {}
}
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: '<string>',
    provider: '<string>',
    config: {},
    providerVoiceId: '<string>',
    voiceMetadata: {}
  })
};

fetch('https://api.us.poly.ai/v1/accounts/{accountId}/voice-library/{voiceId}', 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.us.poly.ai/v1/accounts/{accountId}/voice-library/{voiceId}",
  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' => '<string>',
    'provider' => '<string>',
    'config' => [
        
    ],
    'providerVoiceId' => '<string>',
    'voiceMetadata' => [
        
    ]
  ]),
  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.us.poly.ai/v1/accounts/{accountId}/voice-library/{voiceId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"config\": {},\n  \"providerVoiceId\": \"<string>\",\n  \"voiceMetadata\": {}\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.us.poly.ai/v1/accounts/{accountId}/voice-library/{voiceId}")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"config\": {},\n  \"providerVoiceId\": \"<string>\",\n  \"voiceMetadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us.poly.ai/v1/accounts/{accountId}/voice-library/{voiceId}")

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\": \"<string>\",\n  \"provider\": \"<string>\",\n  \"config\": {},\n  \"providerVoiceId\": \"<string>\",\n  \"voiceMetadata\": {}\n}"

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

200

{
  "voice": {
    "id": "<string>",
    "name": "<string>",
    "provider": "<string>",
    "providerVoiceId": "<string>",
    "config": {},
    "metadata": {},
    "isPolyVoice": false
  }
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

accountId · string · required

voiceId · string · required

Body

application/json

Request schema for updating a voice.

All fields are optional — only provided fields are patched.

name · string

Human-readable voice name

provider · string

TTS provider

config · object

Provider-specific voice config

providerVoiceId · string

Voice ID from the TTS provider

voiceMetadata · object

Additional voice metadata

Response

200

application/json

Successful response

Response for single voice endpoints.

voice · object · required

A single voice as returned by the public API.

Show child attributes