List agent voice choices - Sendora

GET

/

api

/

v1

/

public

/

voice-agents

/

{agent_id}

/

voices

cURL

curl -X GET 'https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/voices' -H "X-API-Key: $SENDORA_API_KEY"

import requests

url = 'https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/voices'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/voices", {
  method: "GET",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("GET", "https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/voices", nil)
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

[
  {
    "id": "<string>",
    "language": "<string>",
    "name": "<string>",
    "provider": "<string>",
    "asset_id": "<string>",
    "capabilities": [
      "<string>"
    ],
    "custom_id": "<string>",
    "description": "<string>",
    "gender": "<string>",
    "is_custom": false,
    "origin": "<string>",
    "preview_url": "<string>",
    "selectable": true,
    "status": "active"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key

string | null

Authorization

string | null

Path Parameters

agent_id

string

required

The voice agent's id: the id from List voice agents. It is also the last part of that page's address in the app.

Response

Successful Response

id

string

required

The voice's id. Pass it as voice_id.

language

string

required

Language returned by the Sendora API.

name

string

required

Name returned by the Sendora API.

provider

string

required

connected service returned by the Sendora API.

asset_id

string | null

The voice's catalog reference. Send it back as voice_asset_id when choosing this voice for an agent.

capabilities

string[]

Capabilities returned by the Sendora API.

custom_id

string | null

The id of a voice the workspace created itself, when the voice is a custom one.

description

string | null

Description returned by the Sendora API.

gender

string | null

Gender returned by the Sendora API.

is_custom

boolean

default:false

Is custom returned by the Sendora API.

origin

string | null

Origin returned by the Sendora API.

preview_url

string | null

Preview url returned by the Sendora API.

selectable

boolean

default:true

Selectable returned by the Sendora API.

status

string

default:active

Status returned by the Sendora API.

cURL

curl -X GET 'https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/voices' -H "X-API-Key: $SENDORA_API_KEY"

import requests

url = 'https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/voices'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/voices", {
  method: "GET",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("GET", "https://api.sendora.ai/api/v1/public/voice-agents/YOUR_ID/voices", nil)
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

[
  {
    "id": "<string>",
    "language": "<string>",
    "name": "<string>",
    "provider": "<string>",
    "asset_id": "<string>",
    "capabilities": [
      "<string>"
    ],
    "custom_id": "<string>",
    "description": "<string>",
    "gender": "<string>",
    "is_custom": false,
    "origin": "<string>",
    "preview_url": "<string>",
    "selectable": true,
    "status": "active"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}