/v1/schemas/cartesia/audio/tts/sse
| field | recorded source |
|---|---|
| schema | Source linked above. upstream-spec Source tracea9ce21d0a3b28a57ef89ece81b676ac90c24bd222b3d9e2a9c10d00b53fe8205{
"fetchedAt": 1793337635,
"extractorVersion": "1",
"verifiedAt": null
} |
Request body
14 properties · 4 required · 9 $defs| property | type | description | constraints |
|---|---|---|---|
| model_id* | enum | The ID of the model to use for the generation. See [Models](/build-with-cartesia/tts-models/latest) all options. | sonic-3.5 | sonic-3 | sonic-preview | sonic-latest · default: "sonic-3.5" |
| transcript* | string | default: "Hi there, it's awesome to meet … | |
| voice* | TTSRequestVoiceSpecifier | ||
| output_format* | SSEOutputFormat | ||
| language | string | Deprecated — use `locale` instead on Sonic 3.6 and later. The language the voice speaks the transcript in, as a code from the languages the model supports (`en`, `hi`). Supported languages are model-specific. See the language support section for the model you … | |
| locale | string | The locale or language the voice speaks the transcript in, as a code from the [supported locales](/build-with-cartesia/capability-guides/advanced-capabilities#which-locales-are-supported) or the languages the model supports (`en-GB`, `hi-IN`, `en`, `hi`). Acce… | |
| normalization | string | Controls how written forms (dates, times, numbers) are converted to spoken forms, independently of the voice's accent. One of `auto` (default), `off`, or a locale code from the [supported locales](/build-with-cartesia/capability-guides/advanced-capabilities#wh… | default: "auto" |
| add_timestamps | boolean | Whether to return word-level timestamps. If `false` (default), no word timestamps will be produced at all. If `true`, the server will return timestamp events containing word-level timing information. | default: false |
| add_phoneme_timestamps | boolean | Whether to return phoneme-level timestamps. If `false` (default), no phoneme timestamps will be produced. If `true`, the server will return timestamp events containing phoneme-level timing information. | default: false |
| use_normalized_timestamps | boolean | Whether to use normalized timestamps (True) or original timestamps (False). | |
| pronunciation_dict_id | string | The ID of a pronunciation dictionary to use for the generation. Pronunciation dictionaries are supported by `sonic-3` models and newer. | |
| generation_config | GenerationConfig | Configure the various attributes of the generated speech. Available on `sonic-3` and `sonic-3.5`; not available on earlier models. | |
| speed | enum | This property is deprecated and may not work for all voices. Use `generation_config.speed` instead. Influences the speed of the generated speech. | slow | normal | fast · default: "normal" · deprecated |
| context_id | string | This can be any string value you find useful. The server will echo back the same `context_id` in events that it sends. > Contexts on the [TTS (WebSocket)](/api-reference/tts/websocket) endpoint are used for [continuations](/build-with-cartesia/capability-guide… |
Types
9 $defsEmotionenum
The primary emotions are `neutral`, `calm`, `angry`, `content`, `sad`, `scared`. For more options, see [Volume, Speed, and Emotion](/build-with-cartesia/capability-guides/volume-speed-emotion#emotion-controls-beta).
neutral | happy | excited | enthusiastic | elated | euphoric · +52 more
GenerationConfigobject
Configure the various attributes of the generated speech. Available on `sonic-3` and `sonic-3.5`; not available on earlier models.
| volume | number | Adjust the volume of the generated speech between 0.5x and 2.0x the default volume. Valid values are between [0.5, 2.0] inclusive. | format: double · default: 1 |
| speed | number | Adjust the speed of the generated speech between 0.6x and 1.5x the default speed. Valid values are between [0.6, 1.5] inclusive. | format: double · default: 1 |
| emotion | enum | Guide the emotion of the generated speech. | neutral | happy | excited | enthusiastic | elated | euphoric · +52 more |
ModelSpeedenum
This property is deprecated and may not work for all voices. Use `generation_config.speed` instead. Influences the speed of the generated speech.
slow | normal | fast · default: "normal"
RawEncodingenum
The encoding format for output audio. See [TTS Output Audio Format](/build-with-cartesia/capability-guides/tts-output-audio-format) if you're unsure what to use.
pcm_f32le | pcm_s16le | pcm_mulaw | pcm_alaw
SSEContextIDstring
SSEOutputFormatobject
| container* | enum | raw · default: "raw" | |
| encoding* | enum | The encoding format for output audio. See [TTS Output Audio Format](/build-with-cartesia/capability-guides/tts-output-audio-format) if you're unsure what to use. | pcm_f32le | pcm_s16le | pcm_mulaw | pcm_alaw |
| sample_rate* | enum | 8000 | 16000 | 22050 | 24000 | 44100 | 48000 |
TTSModelIDenum
The ID of the model to use for the generation. See [Models](/build-with-cartesia/tts-models/latest) all options.
sonic-3.5 | sonic-3 | sonic-preview | sonic-latest · default: "sonic-3.5"
TTSRequestVoiceSpecifierobject
| mode* | enum | id · default: "id" | |
| id* | string | The ID of the voice. Find one in the [Voice Library](https://play.cartesia.ai/voices) or via [List Voices](/api-reference/voices/list). |
VoiceIdstring
The ID of the voice. Find one in the [Voice Library](https://play.cartesia.ai/voices) or via [List Voices](/api-reference/voices/list).
Validate a payload
before you spend tokens$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"cartesia","endpointId":"tts/sse","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}