All endpoints use HTTPS. HTTP is not supported. API keys that call the API
over HTTP may be subject to automatic rotation.
https://api.cartesia.ai. (For WebSockets the corresponding protocol is wss://.)
Always send a Cartesia-Version header
Each request you send our API should have a Cartesia-Version header containing the date (YYYY-MM-DD) when you tested your integration. For WebSockets, you can alternately use the ?cartesia_version query parameter, which will take precedence.
This will help us provide you with timely deprecation notices and enable us to provide automatic backwards compatibility where possible.
For a given Cartesia-Version, we will preserve existing input and output fields, but we may make non-breaking changes, such as:
- Add optional request fields.
- Add additional response fields.
- Change conditions for specific error types
- Add variants to enum-like output values.
Use API keys to authenticate
Authentication is handled using API keys. You can create a new API key from play.cartesia.ai/keys.- For HTTP requests, authentication is handled by adding the field
X-API-Key: <your_api_key>into the HTTP headers. - For WebSocket connections, authentication is handled by passing in the field
?api_key=<your_api_key>when creating the WebSocket connection.
Check response codes
Our API uses standard HTTP response codes; refer to httpstatuses.io.Pass data according to the method
All GET requests use query parameters to pass data. All POST requests use a JSON body ormultipart/form-data.