audio

Text-to-speech

post/v1/audio/speech

Request

  • Base URL: https://api.beatra.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.beatra.ai/v1/audio/speech
  • Auth: none declared. Required headers: Idempotency-Key

Headers

x-request-idstring nullable
Idempotency-Keystring required
authorizationstring nullable

Request body

metadataobject nullable

Caller-supplied metadata; ≤16 keys, key ≤64 chars, value ≤512 chars

callback_urlstring nullable

HTTPS URL beatra will POST the final Task envelope to when the Task reaches a terminal state

callback_signing_key_idstring nullable

Optional standalone callback signing key. Omit for unsigned callback delivery; requires callback_url when provided.

model_optionsobject nullable

Per-model-family passthrough options; opaque to the platform, validated per model

voicestring required

Opaque beatra voice_id (preset or cloned)

inputstring required

Text to synthesize

model'auto' | 'minimax-speech-2.8-hd' | 'minimax-speech-2.8-turbo'

TTS model; 'auto' picks a model compatible with the voice

languagestring nullable

Optional BCP-47 language tag, for example zh-CN, yue-HK, or en-US. Read supported_languages from the selected model's catalog card. When omitted, the voice or provider chooses the language.

format'mp3' | 'wav' | 'flac' | 'opus' | 'pcm'
sample_rate8000 | 16000 | 22050 | 24000 | 32000 | 44100 nullable
speednumber
volumenumber
pitchnumber

Pitch adjustment from -1 to 1: 0 keeps the voice's original pitch, -1 is the lowest and 1 the highest the selected model supports. Use decimals such as 0.25 or -0.5 for subtle tuning.

emotion'happy' | 'sad' | 'angry' | 'fearful' | 'disgusted' | 'surprised' | 'calm' nullable

Provider-neutral discrete speaking emotion

Response

Task accepted

object'task'
task_idstring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required
capabilitystring required
workload_type'model' | 'social_operation'
modelstring nullable

Caller-requested model verbatim (may be 'auto'). Null for social_operation tasks.

resolved_modelstring nullable

Actual model that ran (null until execution starts; equals model for explicit-model calls)

model_selection_reasonunknown
metadataobject nullable
inputobject nullable
outputobject nullable
created_atstring date-time required
started_atstring date-time nullable
deadline_atstring date-time nullable
completed_atstring date-time nullable
cancel_requested_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.