Sign in

4e064cf81dae

latestOpenAPI 3.1.02026-08-131831,331960.0 KB
multimodal

Text to speech

Convert text to speech through the Respan gateway with automatic logging.

post/api/audio/speech

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

X-Data-Respan-Paramsstring

Base64-encoded JSON object of Respan parameters. Legacy X-Data-Keywordsai-Params is still accepted.

Request body

model'tts-1' | 'tts-1-hd' required

TTS model.

inputstring required

Text to generate audio for. Max 4096 characters.

voice'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer' required

Voice to use.

response_format'mp3' | 'opus' | 'aac' | 'flac' | 'wav' | 'pcm'

Audio output format.

speednumber double

Audio speed (0.25 to 4.0).

customer_credentialsApiAudioSpeechPostRequestBodyContentApplicationJsonSchemaCustomerCredentials

Per-customer LLM provider credentials.

disable_logboolean

When true, omits input/output from the log. Metrics still recorded.

metadataApiAudioSpeechPostRequestBodyContentApplicationJsonSchemaMetadata

Custom key-value metadata.

customer_identifierstring

End user identifier.

thread_identifierstring

Conversation thread ID.

Response

Audio content in the requested format.