Generate Speech

curl --request POST \
  --url https://api.heygen.com/v3/voices/speech \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "text": "<string>",
  "voice_id": "<string>",
  "input_type": "text",
  "speed": 1,
  "language": "<string>",
  "locale": "<string>",
  "force_regenerate": false,
  "settings": {}
}
'

import requests

url = "https://api.heygen.com/v3/voices/speech"

payload = {
    "text": "<string>",
    "voice_id": "<string>",
    "input_type": "text",
    "speed": 1,
    "language": "<string>",
    "locale": "<string>",
    "force_regenerate": False,
    "settings": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    text: '<string>',
    voice_id: '<string>',
    input_type: 'text',
    speed: 1,
    language: '<string>',
    locale: '<string>',
    force_regenerate: false,
    settings: {}
  })
};

fetch('https://api.heygen.com/v3/voices/speech', 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/voices/speech",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'text' => '<string>',
    'voice_id' => '<string>',
    'input_type' => 'text',
    'speed' => 1,
    'language' => '<string>',
    'locale' => '<string>',
    'force_regenerate' => false,
    'settings' => [
        
    ]
  ]),
  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/voices/speech"

	payload := strings.NewReader("{\n  \"text\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"input_type\": \"text\",\n  \"speed\": 1,\n  \"language\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"force_regenerate\": false,\n  \"settings\": {}\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.heygen.com/v3/voices/speech")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"input_type\": \"text\",\n  \"speed\": 1,\n  \"language\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"force_regenerate\": false,\n  \"settings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/voices/speech")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"text\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"input_type\": \"text\",\n  \"speed\": 1,\n  \"language\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"force_regenerate\": false,\n  \"settings\": {}\n}"

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

{
  "data": {
    "audio_url": "https://files.heygen.ai/audio/tts_abc123.mp3",
    "duration": 4.5,
    "engine": "starfish",
    "request_id": "req_abc123",
    "word_timestamps": [
      {
        "word": "Hello",
        "start": 0,
        "end": 0.35
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "'voice_id' is required.",
    "param": "voice_id",
    "doc_url": null
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or expired API key. Verify your x-api-key header.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "ai_vendor_access_restricted",
    "message": "Workspace AI vendor policy blocks elevenlabs for this request.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Retry after the duration specified in the Retry-After header.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "voice_provider_error",
    "message": "Our voice service is temporarily unavailable. Please try again in a moment.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "gateway_timeout",
    "message": "Our voice service is temporarily unavailable. Please try again in a moment.",
    "param": null,
    "doc_url": null
  }
}