Skip to content

Replace the organisation's onboarding voice

POST
/voice/voice-library/onboarding-voice

SPENDS CREDITS. Clones the sample as the organisation’s onboarding voice, REPLACING the previous one (voice deletes it at the provider first). There is one per organisation, which is why this is not a collection.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
file
required

A .wav or .mp3 sample. 25 MB maximum.

string format: binary

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string