Google Cloud Text-to-Speech: Node.js Client

release levelnpm version

Cloud Text-to-Speech API client for Node.js

A comprehensive list of changes in each version may be found inthe CHANGELOG.

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Text-to-Speech API.
  4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/text-to-speech

Using the client library

// Imports the Google Cloud client libraryconst textToSpeech = require('@google-cloud/text-to-speech');// Import other required librariesconst fs = require('fs');const util = require('util');// Creates a clientconst client = new textToSpeech.TextToSpeechClient();async function quickStart() {  // The text to synthesize  const text = 'hello, world!';  // Construct the request  const request = {    input: {text: text},    // Select the language and SSML voice gender (optional)    voice: {languageCode: 'en-US', ssmlGender: 'NEUTRAL'},    // select the type of audio encoding    audioConfig: {audioEncoding: 'MP3'},  };  // Performs the text-to-speech request  const [response] = await client.synthesizeSpeech(request);  // Write the binary audio content to a local file  const writeFile = util.promisify(fs.writeFile);  await writeFile('output.mp3', response.audioContent, 'binary');  console.log('Audio content written to file: output.mp3');}quickStart();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource CodeTry it
Text_to_speech.list_voicessource codeOpen in Cloud Shell
Text_to_speech.streaming_synthesizesource codeOpen in Cloud Shell
Text_to_speech.synthesize_speechsource codeOpen in Cloud Shell
Text_to_speech_long_audio_synthesize.synthesize_long_audiosource codeOpen in Cloud Shell
Text_to_speech.list_voicessource codeOpen in Cloud Shell
Text_to_speech.streaming_synthesizesource codeOpen in Cloud Shell
Text_to_speech.synthesize_speechsource codeOpen in Cloud Shell
Text_to_speech_long_audio_synthesize.synthesize_long_audiosource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

TheGoogle Cloud Text-to-Speech Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/text-to-speech@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.