Get a voice

GET

voices

{id}

Get a voice

curl --request GET \
  --url https://api.us.phonely.ai/v1/voices/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.us.phonely.ai/v1/voices/{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.us.phonely.ai/v1/voices/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.us.phonely.ai/v1/voices/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.us.phonely.ai/v1/voices/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "accent": "<string>",
  "gender": "<string>",
  "id": "<string>",
  "is_multilingual": true,
  "language": "<string>",
  "name": "<string>",
  "object": "voice",
  "provider": "<string>",
  "tags": [
    "<string>"
  ]
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An org API key: Authorization: Bearer phk_…

Headers

Phonely-Organization

string | null

Optional. Must be the key's org.

Path Parameters

string

required

The Phonely voice ID, not a provider TTS ID.

Response

Successful Response

A public or organization-owned voice, identified by its Phonely ID.

accent

string | null

required

The stored accent label. null when none is stored.

gender

string | null

required

The stored gender label. null when none is stored.

string

required

The Phonely voice ID to use as an agent's voice_id, not the provider's TTS ID.

is_multilingual

boolean

required

Whether the voice is marked as supporting multiple languages.

language

string | null

required

The stored language identifier, as in the picker. null when absent.

name

string | null

required

The voice name shown in the picker. null when none is stored.

object

string

default:voice

required

The type of this object, always voice.

Allowed value: "voice"

provider

string | null

required

The stored provider identifier, such as cartesia. null when absent.

tags

string[]

required

The descriptive tags shown in the picker, in stored order. Empty when absent.

⌘I

Get a voice

curl --request GET \
  --url https://api.us.phonely.ai/v1/voices/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.us.phonely.ai/v1/voices/{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.us.phonely.ai/v1/voices/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.us.phonely.ai/v1/voices/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.us.phonely.ai/v1/voices/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "accent": "<string>",
  "gender": "<string>",
  "id": "<string>",
  "is_multilingual": true,
  "language": "<string>",
  "name": "<string>",
  "object": "voice",
  "provider": "<string>",
  "tags": [
    "<string>"
  ]
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

API v1

API v1 endpoints

Legacy API

Web SDK

Authorizations

Headers

Path Parameters

Response