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

Stay organized with collections Save and categorize content based on your preferences.

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

HTTP request

POST https://{endpoint}/v3beta1/{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
name

string

Required. Resource name of the experiment to start. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>/experiments/<Experiment ID>.

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.