Skip to content
OpenParablePublic APIs

Dialogflow API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).

Dialogflow API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 55 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://dialogflow.googleapis.com/
Version
v3beta1
Endpoints
55
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://dialogflow.googleapis.com/v3beta1/AGENT/testCases:calculateCoverage" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://dialogflow.googleapis.com/v3beta1/AGENT/testCases:calculateCoverage", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://dialogflow.googleapis.com/v3beta1/AGENT/testCases:calculateCoverage",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v3beta1/{agent}/testCases:calculateCoverageCalculates the test coverage for an agent.
POST/v3beta1/{baseVersion}:compareVersionsCompares the specified base version with target version.
POST/v3beta1/{environment}:deployFlowDeploys a flow to the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
POST/v3beta1/{environment}:runContinuousTestKicks off a continuous test under the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-runn
GET/v3beta1/{name}Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
PATCH/v3beta1/{name}Updates the specified SecuritySettings.
DELETE/v3beta1/{name}Deletes the specified SecuritySettings.
GET/v3beta1/{name}/locationsLists information about the supported locations for this service.
GET/v3beta1/{name}/operationsLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
POST/v3beta1/{name}:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the serv
POST/v3beta1/{name}:exportExports the specified flow to a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
POST/v3beta1/{name}:loadLoads resources in the specified version to the draft flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-runni
GET/v3beta1/{name}:lookupEnvironmentHistoryLooks up the history of the specified Environment.
POST/v3beta1/{name}:restoreRestores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity type
POST/v3beta1/{name}:runKicks off a test case run. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Oper
POST/v3beta1/{name}:startStarts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.
POST/v3beta1/{name}:stopStops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.
POST/v3beta1/{name}:trainTrains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a [long-running operation](https://cloud.google.com/dialogf
POST/v3beta1/{name}:validateValidates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation resu
GET/v3beta1/{parent}/agentsReturns the list of all agents in the specified location.
POST/v3beta1/{parent}/agentsCreates an agent in the specified location. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.goo
GET/v3beta1/{parent}/changelogsReturns the list of Changelogs.
GET/v3beta1/{parent}/continuousTestResultsFetches a list of continuous test results for a given environment.
GET/v3beta1/{parent}/deploymentsReturns the list of all deployments in the specified Environment.
GET/v3beta1/{parent}/entityTypesReturns the list of all session entity types in the specified session.
POST/v3beta1/{parent}/entityTypesCreates a session entity type.
GET/v3beta1/{parent}/environmentsReturns the list of all environments in the specified Agent.
POST/v3beta1/{parent}/environmentsCreates an Environment in the specified Agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation)
GET/v3beta1/{parent}/experimentsReturns the list of all experiments in the specified Environment.
POST/v3beta1/{parent}/experimentsCreates an Experiment in the specified Environment.
GET/v3beta1/{parent}/flowsReturns the list of all flows in the specified agent.
POST/v3beta1/{parent}/flowsCreates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.c
POST/v3beta1/{parent}/flows:importImports the specified flow to the specified agent from a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/
GET/v3beta1/{parent}/intentsReturns the list of all intents in the specified agent.
POST/v3beta1/{parent}/intentsCreates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.googl
GET/v3beta1/{parent}/pagesReturns the list of all pages in the specified flow.
POST/v3beta1/{parent}/pagesCreates a page in the specified flow.
GET/v3beta1/{parent}/resultsFetches a list of results for a given test case.
GET/v3beta1/{parent}/securitySettingsReturns the list of all security settings in the specified location.
POST/v3beta1/{parent}/securitySettingsCreate security settings in the specified location.
GET/v3beta1/{parent}/testCasesFetches a list of test cases for a given agent.
POST/v3beta1/{parent}/testCasesCreates a test case for the given agent.
POST/v3beta1/{parent}/testCases:batchDeleteBatch deletes test cases.
POST/v3beta1/{parent}/testCases:batchRunKicks off a batch run of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The retu
POST/v3beta1/{parent}/testCases:exportExports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a [long
POST/v3beta1/{parent}/testCases:importImports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in t
GET/v3beta1/{parent}/transitionRouteGroupsReturns the list of all transition route groups in the specified flow.
POST/v3beta1/{parent}/transitionRouteGroupsCreates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https:
GET/v3beta1/{parent}/versionsReturns the list of all versions in the specified Flow.
POST/v3beta1/{parent}/versionsCreates a Version in the specified Flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
GET/v3beta1/{parent}/webhooksReturns the list of all webhooks in the specified agent.
POST/v3beta1/{parent}/webhooksCreates a webhook in the specified agent.
POST/v3beta1/{session}:detectIntentProcesses a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types
POST/v3beta1/{session}:fulfillIntentFulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
POST/v3beta1/{session}:matchIntentReturns preliminary intent match results, doesn't change the session status.

Questions

Does the Dialogflow API API need an API key?

Yes. The Dialogflow API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Dialogflow API API support HTTPS?

Yes, the Dialogflow API API is served over HTTPS.

How many endpoints does the Dialogflow API API have?

Its OpenAPI description lists 55 endpoints in version v3beta1. All of them are shown on this page.

What are alternatives to the Dialogflow API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).