API Reference

Reference documentation generated from the TypeScript source of each published package. For install instructions and a first working example, start with Installation.

Pick a package

Most projects need exactly one of these two.

@responsivevoice/core Text-to-speech in the browser. Native voices with automatic server fallback, streaming, and the web player. This is the package behind the CDN bundle.

@responsivevoice/api-client REST client for the ResponsiveVoice API. Use it from Node.js or any server-side runtime, where the Web Speech API does not exist.

Supporting packages

These ship as dependencies of the packages above, so you rarely install them directly.

@responsivevoice/features The page-level speech features — web player, speak-on-select, paragraph navigation, and the rest. core re-exports all of them.

@responsivevoice/types Zod schemas and the TypeScript types inferred from them. api-client re-exports the common ones.

@responsivevoice/text Text chunking, duration estimation, and normalization shared by the packages above.

Other references

REST API The HTTP endpoints themselves — call them from any language.

Browser Support Minimum browser and Node.js versions for each package.