Skip to main content
WSS
cartesia_version
type:string
required

API version, e.g. 2024-11-13

X-API-Key
type:httpApiKey

Use an API key when you're calling from a trusted server.

access_token
type:httpApiKey

Use a short-lived access token when calling from a browser or client app. Learn more here.

Generation Request
type:object

Use this to generate speech for a transcript.

Cancel Context Request
type:object

Use this to cancel a context, so that no more messages are generated for that context.

Audio Chunk Response
type:object

Audio data chunk

Flush Done Response
type:object

Acknowledgment that flush command was received. See Context Flushing for details.

Done Response
type:object

Generation completion signal

Word Timestamps Response
type:object

Word-level timing information

Phoneme Timestamps Response
type:object

Phoneme-level timing information

Error Response
type:object

Error information for TTS WebSocket connections.