Skip to main content
GET
/
projects
/
{id}
/
voices
Voices
curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{id}/voices \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": 1,
    "name": "James",
    "type": "premade",
    "status": "enabled",
    "speaker": null,
    "script_ids": [],
    "speaking_rate": 103,
    "gender": "male",
    "languages": [
      {
        "code": "en_GB",
        "name": "English",
        "accent": "British",
        "preview_url": "https://example.com/James_en_GB_preview.mp3"
      },
      {
        "code": "en_US",
        "name": "English",
        "accent": "American",
        "preview_url": null
      },
      {
        "code": "en_AU",
        "name": "English",
        "accent": "Aussie",
        "preview_url": "https://example.com/James_en_AU_preview.mp3"
      }
    ],
    "cloning_consent": null,
    "clone_errors": [],
    "created": "2022-01-01 00:00:00 UTC",
    "updated": "2022-01-31 12:59:59 UTC",
    "language": "en_GB",
    "secondary_languages": [],
    "service": "azure",
    "preview_url": "https://example.com/James_en_GB_preview.mp3",
    "exclusive": false,
    "custom": false
  },
  {
    "id": 1,
    "name": "Jane",
    "type": "professional",
    "status": "deprecated",
    "speaker": {
      "id": 123,
      "first_name": "Jane",
      "last_name": "Doe",
      "avatar_url": "https://example.com/Jane_avatar.jpg"
    },
    "script_ids": [],
    "speaking_rate": 98,
    "gender": "female",
    "languages": [
      {
        "code": "en_AU",
        "name": "English",
        "accent": "Aussie",
        "preview_url": "https://example.com/Jane_en_AU_preview.mp3"
      }
    ],
    "cloning_consent": "https://example.com/i_agree_to_voice_cloning.mp3",
    "clone_errors": [],
    "created": "2022-01-01 00:00:00 UTC",
    "updated": "2022-01-31 12:59:59 UTC",
    "language": "en_AU",
    "secondary_languages": [],
    "service": "azure",
    "preview_url": "https://example.com/Jane_en_AU_preview.mp3",
    "exclusive": true,
    "custom": true
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
id
string
required

Response

200 - application/json
​
id
integer
​
name
string
​
type
enum<string>
Available options:
premade,
instant,
professional
​
status
enum<string>
Available options:
draft,
recording,
processing,
review,
enabled,
deprecated,
disabled,
unavailable
​
preview_statuses
enum<string>
Available options:
processing,
processed
​
speaker
object | null
​
script_ids
integer[]
​
speaking_rate
integer
​
multilingual_mode
boolean
​
expressiveness
number | null
​
use_speaker_boost
boolean | null
​
similarity_boost
number | null
​
style
number | null
​
languages
object[]
​
cloning_consent
string | null
​
clone_errors
object[]
​
created
string<date-time>
​
updated
string<date-time>
​
logo_pattern
integer | null
​
logo_color
enum<string> | null
Available options:
red,
green,
blue,
purple,
gray,
pink,
cyan
​
gender
enum<string> | null
Available options:
male,
female
​
language
string
deprecated
​
secondary_languages
string[]
deprecated
​
service
string
deprecated
​
preview_url
string | null
deprecated
​
premium
boolean
deprecated
​
exclusive
boolean
deprecated
​
custom
boolean
deprecated
​
additional
boolean