Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details.

Method: projects.locations.agents.environments.experiments.start

HTTP request
Path parameters
Request body
Response body
Authorization scopes
Try it!

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

HTTP request

POST https://{endpoint}/v3/{name=projects/*/locations/*/agents/*/environments/*/experiments/*}:start

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` Required. Resource name of the experiment to start. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>`. Authorization requires the following IAM permission on the specified resource `name`: `dialogflow.experiments.start`

name

string

Required. Resource name of the experiment to start. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/experiments/<ExperimentID>.

Authorization requires the following IAM permission on the specified resource name:

dialogflow.experiments.start

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Experiment.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.