GET
/
organization
/
voices
curl --request GET \
  --url https://api.beyondwords.io/v1/organization/voices \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": 1,
    "name": "James",
    "type": "premade",
    "status": "enabled",
    "speaker": null,
    "script_ids": [],
    "speaking_rate": 103,
    "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,
    "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

Query Parameters

​
filter[language.id]
string

filter by language id

​
filter[speaker.id]
string

filter by speaker id

​
filter[language.code]
string

filter by language code

​
filter[scopes][]
string[]
​
filter[types][]
string[]

filter by voice types

​
filter[statuses][]
string[]

filter by voice statuses

​
filter[preview_statuses][]
string[]

filter by preview status of the voice for its primary language

Response

200
application/json
OK
​
id
integer

Unique identifier for the object

​
name
string

The name of the voice

​
type
enum<string>

The type of the voice

Available options:
premade,
instant,
professional
​
status
enum<string>

The status of the voice

Available options:
draft,
recording,
processing,
review,
enabled,
deprecated,
disabled,
unavailable
​
preview_statuses
enum<string>

The preview status of the voice for its primary language

Available options:
processing,
processed
​
speaker
object | null

The speaker of the voice

​
script_ids
integer[]

The script IDs associated with the voice

​
speaking_rate
integer

The speaking rate of the voice

​
languages
object[]

The languages supported by the voice

​
cloning_consent
string | null

The cloning consent URL for instant and professional voices

​
clone_errors
any[]

An array of voice cloning errors in the standard error format

​
created
string

Time at which the object was created (ISO 8601)

​
updated
string

Time at which the object was updated (ISO 8601)

​
language
string
deprecated

The language of the voice

​
secondary_languages
string[]
deprecated

The secondary languages of the voice

​
service
string
deprecated

The source of the voice

​
preview_url
string | null
deprecated

The preview URL of the voice

​
premium
boolean
deprecated

Whether the voice is premium or not

​
exclusive
boolean
deprecated

Whether the voice is exclusive or not

​
custom
boolean
deprecated

The custom flag of the voice

Previous
Update voice
Next