API ReferenceAgents

List Agent Voices

List the curated voice catalogue available for voice agents. Matches the `ai-api-agents` VMS scope one-for-one, so the same slug set is accepted by POST/PATCH /v1/agents. Personal (cloned) voices are NOT included — they stay on `GET /v1/voices`. The JSON layout intentionally mirrors the TTS `/v1/voices` shape so the console feeds both endpoints into the same voice-picker component.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Response

The curated agent voice catalogue.
idstring

Voice slug. Passed verbatim as voice_id on agent writes.

typeenum

Voice provenance. Always shared on this endpoint — personal / cloned voices are not exposed here; they stay on GET /v1/voices.

display_namestring
modelslist of objects
genderenum

Speaker gender as classified by VMS. notSpecified is used when the source dataset didn’t carry the metadata; the console treats it as a neutral display label rather than a filter gap.

localestring

Default locale for the voice (BCP-47-ish, e.g. en-US).

preview_audiostring or null

Preferred preview clip URL, locale-matched when possible.

avatar_imagestring or null

Avatar URL for the picker UI. Null when no avatar is configured; the wire is intentionally null rather than "" so the picker doesn’t render a broken <img src="">.

tagslist of strings or null

VMS-defined tags (e.g. narrator, young).

Errors

401
Unauthorized Error