Get speaker - Docs and guides

GET

speakers

{id}

Get speaker

curl --request GET \
  --url https://api.beyondwords.io/v1/speakers/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'X-Api-Key: <api-key>'

{
  "id": 1,
  "first_name": "Jane",
  "last_name": "Doe",
  "avatar_url": "https://example.com/avatar.jpg",
  "created": "2023-12-31T00:00:00.000Z",
  "updated": "2023-12-31T00:00:00.000Z",
  "custom_voices": [
    {
      "id": 1
    },
    {
      "name": "Jane"
    },
    {
      "script_ids": [
        123,
        456
      ]
    },
    {
      "cloning_status": "script-preparation"
    },
    {
      "created": "2023-12-31T00:00:00.000Z"
    },
    {
      "updated": "2023-12-31T00:00:00.000Z"
    }
  ],
  "voices": [
    {
      "id": 1
    },
    {
      "name": "Jane"
    }
  ]
}

Gets a speaker from your organization, including associated voices.

Authorizations

X-Api-Key

string

header

required

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

string

required

speaker id

Query Parameters

custom_voices

enum<string>

The level of detail to show for custom_voices in the response: 'none' or 'partial'

Available options:

partial

Response

private access with correct password

integer

Unique identifier for the object

first_name

string

The first name of the speaker

last_name

string | null

The last name of the speaker

avatar_url

string | null

The image URL of the speaker

created

string<date-time>

Time at which the object was created (ISO 8601)

updated

string<date-time>

Time at which the object was updated (ISO 8601)

custom_voices

object[] | null

The custom voices for the speaker

Show child attributes

voices

object[] | null

The voices for the speaker

Show child attributes

Update speakerUpdates a speaker in your organization

Get speaker

curl --request GET \
  --url https://api.beyondwords.io/v1/speakers/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'X-Api-Key: <api-key>'

{
  "id": 1,
  "first_name": "Jane",
  "last_name": "Doe",
  "avatar_url": "https://example.com/avatar.jpg",
  "created": "2023-12-31T00:00:00.000Z",
  "updated": "2023-12-31T00:00:00.000Z",
  "custom_voices": [
    {
      "id": 1
    },
    {
      "name": "Jane"
    },
    {
      "script_ids": [
        123,
        456
      ]
    },
    {
      "cloning_status": "script-preparation"
    },
    {
      "created": "2023-12-31T00:00:00.000Z"
    },
    {
      "updated": "2023-12-31T00:00:00.000Z"
    }
  ],
  "voices": [
    {
      "id": 1
    },
    {
      "name": "Jane"
    }
  ]
}