Skip to main content

Get Started with Authentication

To use the Typecast API, you’ll need to authenticate your requests with an API key. Follow these steps:
1

First Step

Visit your Typecast API Console to generate a new API key
2

Second Step

Keep your API key secure - we recommend storing it as an environment variable

Make your first request

1

Install SDK

All SDKs require the latest version.
  • Python: If you have an older version, upgrade with pip install --upgrade typecast-python
  • Javascript: If you have an older version, upgrade with npm update @neosapience/typecast-js
  • C#: Update with dotnet add package typecast-csharp
  • Java: Update the version in your pom.xml or build.gradle
  • Kotlin: Update the version in your build.gradle.kts
  • Rust: Update the version in your Cargo.toml
If you only need to synthesize speech and save an audio file, use the SDK’s generateToFile or generate_to_file helper. Each SDK page includes a language-specific example.
2

Import and Initialize

To browse and select available voice IDs for your requests, please refer to Listing all voices in our API Reference.

List all voices

To use Typecast effectively, you need access to voice IDs. The /v2/voices endpoint provides a complete list of available voices with their unique identifiers, names, supported models, and emotions. You can filter voices by model, gender, age, and use cases using optional query parameters.
You can preview available API voices and listen to sample audio without making an API call on the Voices page. Use it to compare voices first, then copy the Voice ID into your API request.
The response will be a JSON array of voice objects, each containing:
You’ll need a valid voice ID when making text-to-speech requests. With ssfm-v30, all 7 emotion presets are available across all voices.

Stream audio in real time

For low-latency applications, use the streaming endpoint to play audio as chunks arrive — no need to wait for full synthesis. WAV streaming format: 32000 Hz, 16-bit, mono PCM. The first chunk includes a 44-byte WAV header; subsequent chunks are raw PCM only.
See each SDK documentation for more languages (Go, Rust, Swift, C#, Kotlin, C) with real-time playback examples.

Generate subtitles with Timestamp TTS

Need word-level timing for captions, karaoke, or lip-sync? Use the timestamp TTS endpoint — it returns the audio together with per-word (and optionally per-character) alignment data.
See each SDK documentation for all 11 language examples including subtitle export helpers (toSrt(), toVtt()).

Next steps

Congratulations on creating your first AI voice! Here are some resources to help you dive deeper:

API Reference

Learn how to use the Typecast API

Models

Learn about ssfm-v30 and ssfm-v21 models

Changelog

See the latest API changes and updates