> ## Documentation Index
> Fetch the complete documentation index at: https://docs.responsivevoice.org/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API

The ResponsiveVoice REST API generates speech audio from any language or platform — no website required. Use it for:

- Server-side audio generation
- Mobile apps (Android, iOS) and other non-browser clients
- Batch processing of text to speech
- Platforms without Web Speech API support

**Base URL:** `https://texttospeech.responsivevoice.org/v2`

> [!TIP]
> **Prefer a client library**
>
> A client library wraps these endpoints with typing, retries, and streaming.
> For TypeScript or Node, use
> [`@responsivevoice/api-client`](/sdks/typescript/). From a language without a
> client library, call the REST endpoints directly as documented below.

> [!TIP]
> Building a website rather than calling the API directly? Embed
> [`@responsivevoice/core`](/getting-started/quick-start/) instead — it speaks
> via the browser's Web Speech API and only falls back to this REST API when
> needed.

## Features

- **Multilingual built-in voice catalog**
- **Streaming support** via HTTP audio streaming and WebSocket streaming
- **BYOK premium providers** — bring your own provider API keys for premium voices
- **CDN-cacheable** GET endpoint for efficient audio delivery
- **HATEOAS navigation** links in voice responses

## Interactive Documentation

Explore the API interactively with the [Scalar API Reference](https://texttospeech.responsivevoice.org/reference).

The full OpenAPI specification is available at [`/openapi.json`](https://texttospeech.responsivevoice.org/openapi.json) — import it into Postman, Insomnia, or other API tools.

## Endpoint Reference

Detailed endpoint documentation is auto-generated from the OpenAPI specification — see the [Endpoint Reference](/rest-api/reference/).

> [!WARNING]
> **V1 Deprecation**
>
> V1 is deprecated. Only `GET /v1/text:synthesize` remains for backward compatibility with the legacy JS client. All new integrations should use the v2 endpoints documented in the [Endpoint Reference](/rest-api/reference/).