voice

Synthesise (or fetch from cache) the clips a route will speak.

post/v1/voice/clips

Request

  • Base URL: https://api.mapmap.ai
  • URL: https://api.mapmap.ai/v1/voice/clips
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_key

Request body

formatstring required

Container: opus (Ogg Opus 48 kHz, for Android) or m4a (MPEG-4 AAC 44.1 kHz, for iOS, which cannot play Ogg Opus).

genderstring nullable

female or male, alongside locale: that locale's default voice of this gender. With voice, the voice must be of this gender. Needs locale or voice.

localestring nullable

BCP 47 locale (en-GB, fr-FR), answered by that locale's default voice for gender, or for the locale's default gender (female) when gender is absent. With neither voice nor locale the voice is the en-GB default (en-gb-f).

providersstring[] nullable

Provider classes this request may be answered by: elevenlabs, open (the self-hosted open-source voices) or both. A voice outside them is replaced by its fallback; ["open"] never touches ElevenLabs. Absent allows both.

voicestring nullable

Registry voice id (en-gb-f, amelia, fr-fr-m). Wins over locale; when both are sent the voice must speak that locale.

Response

Clip URLs, cache flags and durations; pending for clips still being synthesised

Changes

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