Section ID:
Section ID:
DOC-API-MODEL-schema-on2m1c27d9#overview
TTSConfig
Cartesia Sonic-3 text-to-speech configuration for a Socayo agent.
Meaning and usage
Section ID: DOC-API-MODEL-schema-on2m1c27d9#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-on2m1c27d9#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
Section ID: DOC-API-MODEL-schema-on2m1c27d9#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-on2m1c27d9#field-voiceidSection ID: DOC-API-MODEL-schema-on2m1c27d9#request-field-voiceidvoiceId | string | Required in requests | Provider-specific voice identifier (Cartesia voice_id) Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-on2m1c27d9#field-modelSection ID: DOC-API-MODEL-schema-on2m1c27d9#request-field-modelmodel | string | Optional | Optional Cartesia model identifier (e.g., "sonic-english") |
Section ID: DOC-API-MODEL-schema-on2m1c27d9#field-samplerateSection ID: DOC-API-MODEL-schema-on2m1c27d9#request-field-sampleratesampleRate | string (int64) | Optional | Optional sample rate override (Hz) Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-on2m1c27d9#field-volumeSection ID: DOC-API-MODEL-schema-on2m1c27d9#request-field-volumevolume | number (double) | Required in requests | Volume multiplier (0.5..2.0) Minimum: 0.5. Maximum: 2. |
Section ID: DOC-API-MODEL-schema-on2m1c27d9#field-speedSection ID: DOC-API-MODEL-schema-on2m1c27d9#request-field-speedspeed | number (double) | Required in requests | Speed multiplier (0.6..1.5) Minimum: 0.6. Maximum: 1.5. |
Section ID: DOC-API-MODEL-schema-on2m1c27d9#field-emotionSection ID: DOC-API-MODEL-schema-on2m1c27d9#request-field-emotionemotion | string | Optional | Single emotion string (e.g., "neutral", "excited") |
Section ID: DOC-API-MODEL-schema-on2m1c27d9#field-languageSection ID: DOC-API-MODEL-schema-on2m1c27d9#request-field-languagelanguage | string | Optional | Cartesia language code (e.g., "EN") |
DOC-API-MODEL-schema-on2m1c27d9#validation
Request validation
Section ID: DOC-API-MODEL-schema-on2m1c27d9#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
voiceId | Minimum length | 1 |
volume | At most | 2 |
volume | At least | 0.5 |
speed | At most | 1.5 |
speed | At least | 0.6 |
Where used
Section ID: DOC-API-MODEL-schema-on2m1c27d9#where-used
| Reference | Relationship |
|---|---|
| Create a voice session (in progress) | POST /api/v1/llm/create-daily-session |
Models containing this value
| Model | Relationship |
|---|---|
| SocayoAgentConfig | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-on2m1c27d9