APIHub
Back to Explore

Dialogflow

Natural Language Processing

Machine Learning
apiKey
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/v3beta1/{name}:stop

Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.

  • name (path, required) — Required. Resource name of the experiment to stop. Format: `projects//locations//agents//environments//experiments/`.
GET

/v3beta1/{agent}/testCases:calculateCoverage

Calculates the test coverage for an agent.

  • agent (path, required) — Required. The agent to calculate coverage for. Format: `projects//locations//agents/`.
  • type (query) — Required. The type of coverage requested.
POST

/v3beta1/{baseVersion}:compareVersions

Compares the specified base version with target version.

  • baseVersion (path, required) — Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`.
POST

/v3beta1/{environment}:deployFlow

Deploys a flow to the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse

  • environment (path, required) — Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`.
POST

/v3beta1/{environment}:runContinuousTest

Kicks off a continuous test under the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: RunContinuousTestMetadata - `response`: RunContinuousTestResponse

  • environment (path, required) — Required. Format: `projects//locations//agents//environments/`.
DELETE

/v3beta1/{name}

Deletes the specified SecuritySettings.

  • name (path, required) — Required. The name of the SecuritySettings to delete. Format: `projects//locations//securitySettings/`.
  • force (query) — This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).
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.

  • name (path, required) — The name of the operation resource.
  • languageCode (query) — The language to retrieve the intent for. The following fields are language dependent: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
PATCH

/v3beta1/{name}

Updates the specified SecuritySettings.

  • name (path, required) — Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: `projects//locations//securitySettings/`.
  • updateMask (query) — Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.
GET

/v3beta1/{name}/locations

Lists information about the supported locations for this service.

  • name (path, required) — The resource that owns the locations collection, if applicable.
  • filter (query) — A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
  • pageSize (query, limit) — The maximum number of results to return. If not set, the service selects a default.
  • pageToken (query) — A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
GET

/v3beta1/{name}/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • name (path, required) — The name of the operation's parent resource.
  • filter (query) — The standard list filter.
  • pageSize (query, limit) — The standard list page size.
  • pageToken (query) — The standard list page token.
POST

/v3beta1/{name}:cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

  • name (path, required) — The name of the operation resource to be cancelled.
POST

/v3beta1/{name}:export

Exports 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). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

  • name (path, required) — Required. The name of the flow to export. Format: `projects//locations//agents//flows/`.
POST

/v3beta1/{name}:load

Loads 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-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

  • name (path, required) — Required. The Version to be loaded to draft flow. Format: `projects//locations//agents//flows//versions/`.
GET

/v3beta1/{name}:lookupEnvironmentHistory

Looks up the history of the specified Environment.

  • name (path, required) — Required. Resource name of the environment to look up the history for. Format: `projects//locations//agents//environments/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{name}:restore

Restores 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 types, flows) will be removed. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

  • name (path, required) — Required. The name of the agent to restore into. Format: `projects//locations//agents/`.
POST

/v3beta1/{name}:run

Kicks 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 `Operation` type has the following method-specific fields: - `metadata`: RunTestCaseMetadata - `response`: RunTestCaseResponse

  • name (path, required) — Required. Format of test case name to run: `projects//locations/ /agents//testCases/`.
POST

/v3beta1/{name}:start

Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.

  • name (path, required) — Required. Resource name of the experiment to start. Format: `projects//locations//agents//environments//experiments/`.
POST

/v3beta1/{name}:train

Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

  • name (path, required) — Required. The flow to train. Format: `projects//locations//agents//flows/`.
POST

/v3beta1/{name}:validate

Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.

  • name (path, required) — Required. The flow to validate. Format: `projects//locations//agents//flows/`.
GET

/v3beta1/{parent}/agents

Returns the list of all agents in the specified location.

  • parent (path, required) — Required. The location to list all agents for. Format: `projects//locations/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/agents

Creates an agent in the specified location. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

  • parent (path, required) — Required. The location to create a agent for. Format: `projects//locations/`.
GET

/v3beta1/{parent}/changelogs

Returns the list of Changelogs.

  • parent (path, required) — Required. The agent containing the changelogs. Format: `projects//locations//agents/`.
  • filter (query) — The filter string. Supports filter by user_email, resource, type and create_time. Some examples: 1. By user email: user_email = "someone@google.com" 2. By resource name: resource = "projects/123/locations/global/agents/456/flows/789" 3. By resource display name: display_name = "my agent" 4. By action: action = "Create" 5. By type: type = "flows" 6. By create time. Currently predicates on `create_time` and `create_time_epoch_seconds` are supported: create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.01Z 7. Combination of above filters: resource = "projects/123/locations/global/agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <= 2017-01-15T01:30:15.01Z
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
GET

/v3beta1/{parent}/continuousTestResults

Fetches a list of continuous test results for a given environment.

  • parent (path, required) — Required. The environment to list results for. Format: `projects//locations//agents// environments/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
GET

/v3beta1/{parent}/deployments

Returns the list of all deployments in the specified Environment.

  • parent (path, required) — Required. The Environment to list all environments for. Format: `projects//locations//agents//environments/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 20 and at most 100.
  • pageToken (query) — The next_page_token value returned from a previous list request.
GET

/v3beta1/{parent}/entityTypes

Returns the list of all session entity types in the specified session.

  • parent (path, required) — Required. The session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/entityTypes

Creates a session entity type.

  • parent (path, required) — Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.
  • languageCode (query) — The language of the following fields in `entity_type`: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
GET

/v3beta1/{parent}/environments

Returns the list of all environments in the specified Agent.

  • parent (path, required) — Required. The Agent to list all environments for. Format: `projects//locations//agents/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 20 and at most 100.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/environments

Creates an Environment in the specified Agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: Environment

  • parent (path, required) — Required. The Agent to create an Environment for. Format: `projects//locations//agents/`.
GET

/v3beta1/{parent}/experiments

Returns the list of all experiments in the specified Environment.

  • parent (path, required) — Required. The Environment to list all environments for. Format: `projects//locations//agents//environments/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 20 and at most 100.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/experiments

Creates an Experiment in the specified Environment.

  • parent (path, required) — Required. The Agent to create an Environment for. Format: `projects//locations//agents//environments/`.
GET

/v3beta1/{parent}/flows

Returns the list of all flows in the specified agent.

  • parent (path, required) — Required. The agent containing the flows. Format: `projects//locations//agents/`.
  • languageCode (query) — The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/flows

Creates 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.com/dialogflow/cx/docs/concept/training).

  • parent (path, required) — Required. The agent to create a flow for. Format: `projects//locations//agents/`.
  • languageCode (query) — The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.event_handlers.trigger_fulfillment.conditional_cases` * `Flow.transition_routes.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
POST

/v3beta1/{parent}/flows:import

Imports 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/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ImportFlowResponse Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

  • parent (path, required) — Required. The agent to import the flow into. Format: `projects//locations//agents/`.
GET

/v3beta1/{parent}/intents

Returns the list of all intents in the specified agent.

  • parent (path, required) — Required. The agent to list all intents for. Format: `projects//locations//agents/`.
  • intentView (query) — The resource view to apply to the returned intent.
  • languageCode (query) — The language to list intents for. The following fields are language dependent: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/intents

Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

  • parent (path, required) — Required. The agent to create an intent for. Format: `projects//locations//agents/`.
  • languageCode (query) — The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
POST

/v3beta1/{parent}/testCases:export

Exports 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-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportTestCasesMetadata - `response`: ExportTestCasesResponse

  • parent (path, required) — Required. The agent where to export test cases from. Format: `projects//locations//agents/`.
GET

/v3beta1/{parent}/pages

Returns the list of all pages in the specified flow.

  • parent (path, required) — Required. The flow to list all pages for. Format: `projects//locations//agents//flows/`.
  • languageCode (query) — The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/pages

Creates a page in the specified flow.

  • parent (path, required) — Required. The flow to create a page for. Format: `projects//locations//agents//flows/`.
  • languageCode (query) — The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.entry_fulfillment.conditional_cases` * `Page.event_handlers.trigger_fulfillment.messages` * `Page.event_handlers.trigger_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.conditional_cases` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.conditional_cases` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
GET

/v3beta1/{parent}/results

Fetches a list of results for a given test case.

  • parent (path, required) — Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.
  • filter (query) — The filter expression used to filter test case results. See [API Filtering](https://aip.dev/160). The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operator `environment` `=`, `IN` (Use value `draft` for draft environment) `test_time` `>`, ` 1602540713" matches any test case results with test time later than a unix timestamp in seconds 1602540713.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
GET

/v3beta1/{parent}/securitySettings

Returns the list of all security settings in the specified location.

  • parent (path, required) — Required. The location to list all security settings for. Format: `projects//locations/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 20 and at most 100.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/securitySettings

Create security settings in the specified location.

  • parent (path, required) — Required. The location to create an SecuritySettings for. Format: `projects//locations/`.
GET

/v3beta1/{parent}/testCases

Fetches a list of test cases for a given agent.

  • parent (path, required) — Required. The agent to list all pages for. Format: `projects//locations//agents/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.
  • pageToken (query) — The next_page_token value returned from a previous list request.
  • view (query) — Specifies whether response should include all fields or just the metadata.
POST

/v3beta1/{parent}/testCases

Creates a test case for the given agent.

  • parent (path, required) — Required. The agent to create the test case for. Format: `projects//locations//agents/`.
POST

/v3beta1/{parent}/testCases:batchDelete

Batch deletes test cases.

  • parent (path, required) — Required. The agent to delete test cases from. Format: `projects//locations//agents/`.
POST

/v3beta1/{parent}/testCases:batchRun

Kicks 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 returned `Operation` type has the following method-specific fields: - `metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse

  • parent (path, required) — Required. Agent name. Format: `projects//locations//agents/ `.
POST

/v3beta1/{parent}/testCases:import

Imports 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 the imported test case is neglected. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportTestCasesMetadata - `response`: ImportTestCasesResponse

  • parent (path, required) — Required. The agent to import test cases to. Format: `projects//locations//agents/`.
GET

/v3beta1/{parent}/transitionRouteGroups

Returns the list of all transition route groups in the specified flow.

  • parent (path, required) — Required. The flow to list all transition route groups for. Format: `projects//locations//agents//flows/`.
  • languageCode (query) — The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/transitionRouteGroups

Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

  • parent (path, required) — Required. The flow to create an TransitionRouteGroup for. Format: `projects//locations//agents//flows/`.
  • languageCode (query) — The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
GET

/v3beta1/{parent}/versions

Returns the list of all versions in the specified Flow.

  • parent (path, required) — Required. The Flow to list all versions for. Format: `projects//locations//agents//flows/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 20 and at most 100.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/versions

Creates 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 returned `Operation` type has the following method-specific fields: - `metadata`: CreateVersionOperationMetadata - `response`: Version

  • parent (path, required) — Required. The Flow to create an Version for. Format: `projects//locations//agents//flows/`.
GET

/v3beta1/{parent}/webhooks

Returns the list of all webhooks in the specified agent.

  • parent (path, required) — Required. The agent to list all webhooks for. Format: `projects//locations//agents/`.
  • pageSize (query, limit) — The maximum number of items to return in a single page. By default 100 and at most 1000.
  • pageToken (query) — The next_page_token value returned from a previous list request.
POST

/v3beta1/{parent}/webhooks

Creates a webhook in the specified agent.

  • parent (path, required) — Required. The agent to create a webhook for. Format: `projects//locations//agents/`.
POST

/v3beta1/{session}:detectIntent

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).

  • session (path, required) — Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
POST

/v3beta1/{session}:fulfillIntent

Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.

  • session (path, required) — Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
POST

/v3beta1/{session}:matchIntent

Returns preliminary intent match results, doesn't change the session status.

  • session (path, required) — Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).

55 endpoints auto-detected

Authentication

This API requires authentication: apiKey.

curl -X POST \
  "https://cloud.google.com/dialogflow/docs//v3beta1/{name}:stop"

cloud.google.com · HTTPS only