Dialogflow API: Nodejs Client

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

npm version

Dialogflow 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 Dialogflow API API.
  4. Set up authentication so you can access theAPI from your local workstation.### Installing the client library
npm install @google-cloud/dialogflow-cx

Samples

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

SampleSource Code
create agentsource code
delete agentsource code
export agentsource code
get agentsource code
get agent validation resultsource code
get generative settingssource code
list agentssource code
restore agentsource code
update agentsource code
update generative settingssource code
validate agentsource code
get changelogsource code
list changelogssource code
get deploymentsource code
list deploymentssource code
create entity typesource code
delete entity typesource code
export entity typessource code
get entity typesource code
import entity typessource code
list entity typessource code
update entity typesource code
create environmentsource code
delete environmentsource code
deploy flowsource code
get environmentsource code
list continuous test resultssource code
list environmentssource code
lookup environment historysource code
run continuous testsource code
update environmentsource code
create experimentsource code
delete experimentsource code
get experimentsource code
list experimentssource code
start experimentsource code
stop experimentsource code
update experimentsource code
create flowsource code
delete flowsource code
export flowsource code
get flowsource code
get flow validation resultsource code
import flowsource code
list flowssource code
train flowsource code
update flowsource code
validate flowsource code
create generatorsource code
delete generatorsource code
get generatorsource code
list generatorssource code
update generatorsource code
create intentsource code
delete intentsource code
export intentssource code
get intentsource code
import intentssource code
list intentssource code
update intentsource code
create pagesource code
delete pagesource code
get pagesource code
list pagessource code
update pagesource code
create security settingssource code
delete security settingssource code
get security settingssource code
list security settingssource code
update security settingssource code
create session entity typesource code
delete session entity typesource code
get session entity typesource code
list session entity typessource code
update session entity typesource code
detect intentsource code
fulfill intentsource code
match intentsource code
server streaming detect intentsource code
streaming detect intentsource code
submit answer feedbacksource code
cloudsource code
batch delete test casessource code
batch run test casessource code
calculate coveragesource code
create test casesource code
export test casessource code
get test casesource code
get test case resultsource code
import test casessource code
list test case resultssource code
list test casessource code
run test casesource code
update test casesource code
create transition route groupsource code
delete transition route groupsource code
get transition route groupsource code
list transition route groupssource code
update transition route groupsource code
compare versionssource code
create versionsource code
delete versionsource code
get versionsource code
list versionssource code
load versionsource code
update versionsource code
create webhooksource code
delete webhooksource code
get webhooksource code
list webhookssource code
update webhooksource code
create agentsource code
delete agentsource code
export agentsource code
get agentsource code
get agent validation resultsource code
get generative settingssource code
list agentssource code
restore agentsource code
update agentsource code
update generative settingssource code
validate agentsource code
get changelogsource code
list changelogssource code
delete conversationsource code
get conversationsource code
list conversationssource code
get deploymentsource code
list deploymentssource code
create entity typesource code
delete entity typesource code
export entity typessource code
get entity typesource code
import entity typessource code
list entity typessource code
update entity typesource code
create environmentsource code
delete environmentsource code
deploy flowsource code
get environmentsource code
list continuous test resultssource code
list environmentssource code
lookup environment historysource code
run continuous testsource code
update environmentsource code
create examplesource code
delete examplesource code
get examplesource code
list examplessource code
update examplesource code
create experimentsource code
delete experimentsource code
get experimentsource code
list experimentssource code
start experimentsource code
stop experimentsource code
update experimentsource code
create flowsource code
delete flowsource code
export flowsource code
get flowsource code
get flow validation resultsource code
import flowsource code
list flowssource code
train flowsource code
update flowsource code
validate flowsource code
create generatorsource code
delete generatorsource code
get generatorsource code
list generatorssource code
update generatorsource code
create intentsource code
delete intentsource code
export intentssource code
get intentsource code
import intentssource code
list intentssource code
update intentsource code
create pagesource code
delete pagesource code
get pagesource code
list pagessource code
update pagesource code
create playbooksource code
create playbook versionsource code
delete playbooksource code
delete playbook versionsource code
export playbooksource code
get playbooksource code
get playbook versionsource code
import playbooksource code
list playbook versionssource code
list playbookssource code
restore playbook versionsource code
update playbooksource code
create security settingssource code
delete security settingssource code
get security settingssource code
list security settingssource code
update security settingssource code
create session entity typesource code
delete session entity typesource code
get session entity typesource code
list session entity typessource code
update session entity typesource code
detect intentsource code
fulfill intentsource code
match intentsource code
server streaming detect intentsource code
streaming detect intentsource code
submit answer feedbacksource code
cloudsource code
batch delete test casessource code
batch run test casessource code
calculate coveragesource code
create test casesource code
export test casessource code
get test casesource code
get test case resultsource code
import test casessource code
list test case resultssource code
list test casessource code
run test casesource code
update test casesource code
create toolsource code
create tool versionsource code
delete toolsource code
delete tool versionsource code
export toolssource code
get toolsource code
get tool versionsource code
list tool versionssource code
list toolssource code
restore tool versionsource code
update toolsource code
create transition route groupsource code
delete transition route groupsource code
get transition route groupsource code
list transition route groupssource code
update transition route groupsource code
compare versionssource code
create versionsource code
delete versionsource code
get versionsource code
list versionssource code
load versionsource code
update versionsource code
create webhooksource code
delete webhooksource code
get webhooksource code
list webhookssource code
update webhooksource code

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/dialogflow-cx@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.mdand a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template.

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-12-03 UTC.