Text to Speech API Documentation

Start with authentication, ship voice generation flows, and scale delivery with predictable endpoint behavior. This hub maps every public Clariva REST and SDK resource.

Quickstart

1. Create an API key From Dashboard -> Settings -> API Keys, create a scoped key for your organization.
2. List voices Fetch /api/v1/voices/system for public voices, then /api/v1/voices for org + system catalog.
3. Create a generation POST text and voice_id to /api/v1/generations with optional tuning controls.
4. Fetch generated audio Stream WAV from /api/v1/generations/{generation_id}/audio when ready.

Documentation index

Authentication

API key format, secure usage, and production auth conventions.

Voices API

Catalog, create custom voices, retrieve, and stream source audio.

Generations API

Generate speech, inspect records, and fetch output WAV assets.

Usage

Subscription status and estimated cost telemetry endpoint.

Errors & Limits

Error envelope, status code mapping, and retry strategy.

SDK

Install @clariva/sdk and integrate with typed resource clients.

Platform facts

API Version: v1
Payload Format: snake_case JSON
Auth: Bearer API key
Audio: WAV binary stream

Authorization header

Use this header on authenticated API routes.

bashAuth header2 lines

curl -X GET 'https://app.clariva.ai/api/v1/voices' \
  -H 'Authorization: Bearer cv_live_***********************************'

Quickstart

Documentation index

Platform facts

Authorization header

Search documentation