Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Import a provider voice by its ID. To import an ElevenLabs Professional Voice Clone by its share link, send CreateShareLinkVoiceImportRequest instead.

provider
enum<string>
required
Available options:
CARTESIA,
ELEVENLABS,
FISH_AUDIO
providerVoiceId
string
required

Voice identifier from the selected provider.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
displayName
string

Optional name override. Defaults to the provider name (trimmed and limited to 191 characters), or Imported if unavailable.

Required string length: 1 - 191
providerModelId
enum<string>

Supported model for the selected provider. Omit for the provider default.

Available options:
sonic-3.6,
sonic-3.6-2026-08-27,
sonic-3.5,
sonic-3.5-2026-05-04,
sonic-3,
sonic-3-2026-01-12,
sonic-2,
sonic-latest,
eleven_v4_turbo,
eleven_v3_conversational,
eleven_v4,
eleven_v3,
eleven_flash_v2_5,
eleven_multilingual_v2,
eleven_flash_v2,
eleven_turbo_v2_5,
s2.1-pro,
s2-pro,
s1
providerConfig
object
sampleUrl
string<uri>
gender
enum<string>
Available options:
MALE,
FEMALE,
NEUTRAL
country
string
Required string length: 2
description
string

Optional description override. Defaults to provider metadata, or null if unavailable. An explicit empty string is preserved.

useOrganizationKey
boolean

ELEVENLABS only. Validate and speak with your organization's saved ElevenLabs API key (PUT /v1/voices/elevenlabs-key) instead of Anam's, for a voice in your own ElevenLabs account: an instant clone, a Voice Design voice or a Professional Voice Clone. The voice gets isZdr: false, and ElevenLabs bills its speech to the key's account.

Response

A share link for a voice the organization already has on this model; its preview was regenerated and any displayName applied.

A voice preset a persona can use for text-to-speech.

id
string<uuid>

Unique identifier for the voice.

displayName
string

Human-readable name shown in the Lab.

provider
enum<string>

Upstream TTS provider for this voice.

Available options:
CARTESIA,
ELEVENLABS,
FISH_AUDIO
providerVoiceId
string | null

The upstream provider's identifier for the voice.

providerModelId
string | null

The upstream provider's model identifier used to generate speech.

sampleUrl
string<uri> | null

URL of a short audio preview of the voice.

previewSampleUrl
string<uri> | null

Alias for sampleUrl, kept for backwards compatibility.

gender
enum<string> | null

Perceived gender of the voice, if categorised.

Available options:
MALE,
FEMALE,
NEUTRAL,
null
country
string | null

ISO 3166-1 alpha-2 country code representing the voice's accent.

description
string | null

Free-form description of the voice's character.

displayTags
string[]

Tags used to categorise the voice in the Lab UI.

isZdr
boolean

Whether this voice meets the Zero Data Retention requirements.

createdByOrganizationId
string | null

ID of the organization that created the voice, or null for stock voices. IDs may be either UUIDs or nanoid-style strings depending on when the organization was created.

createdAt
string<date-time>

Timestamp when the voice was created.

updatedAt
string<date-time>

Timestamp when the voice was last updated.