Skip to main content
POST
Synthesize voice audio

Authorizations

Authorization
string
header
required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Body

application/json
name
string
required

Human-readable name for this resource.

Value constraints

Required string length: 1 - 100
text
string
required

Text to speak: up to 5,000 characters for ElevenLabs and 4,096 for OpenAI.

Value constraints

Required string length: 1 - 5000
provider
enum<string>
required

Specifies provider for this management platform access synthesize voice audio request.

Allowed values

Available options:
elevenlabs,
openai
voiceId
string
required

ElevenLabs voice ID, or an OpenAI voice name such as alloy.

Value constraints

Required string length: 1 - 64
projectId
string<uuid>

Project that owns the asset. Required for organization keys.

Value constraints

model
string

ElevenLabs: eleven_multilingual_v2 (default), eleven_flash_v2_5, eleven_turbo_v2_5. OpenAI: gpt-4o-mini-tts (default), tts-1, tts-1-hd.

Value constraints

Required string length: 1 - 64
credentialId
string<uuid>

Use your stored key for the provider. Omit to use Polymorfa's key.

Value constraints

retentionDays
integer

Specifies retention days for this management platform access synthesize voice audio request.

Value constraints

Required range: 1 <= x <= 3650

Response

Asset created, now transcoding.

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object
required

Structured data carried by this object.