Skip to content

List the preset voices an agent can speak with

GET
/voice/voice-library/presets

The public preset catalogue - the source of voice ids for an agent.

Not org-specific: these are the shared presets, the same for every organisation. Cloned voices belong to an org and are not listed here.

Voice falls back to a small curated list when the speech provider is unreachable, so an empty result means something is wrong rather than that there are no voices.

Authorizations

Parameters

Query Parameters

limit

Rows to return.

integer
default: 50 >= 1 <= 200

Rows to return.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A LIST result from voice, normalised so items is always present.

Voice is inconsistent about whether a list comes back bare or under a named key (collections, files, routes, chats, …). Both are preserved: the original key is kept for anyone reading voice’s docs, and items always holds the same rows so a client can page one way.

object
items
Array
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