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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis page details how to start an experiment using the Dialogflow CX API, specifically transitioning it from a PENDING to RUNNING state.\u003c/p\u003e\n"],["\u003cp\u003eThe process involves sending a POST request to a specific URL, constructed with parameters that identify the target experiment resource.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for starting an experiment must be empty, with all required information conveyed via the URL path parameters.\u003c/p\u003e\n"],["\u003cp\u003eUpon a successful request, the API returns an Experiment object, which provides detailed information on the now running experiment.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required, necessitating either the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/dialogflow\u003c/code\u003e OAuth scope, and specific IAM permissions to be met.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.agents.environments.experiments.start\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nStarts the specified [Experiment](/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.environments.experiments#Experiment). This rpc only changes the state of experiment from PENDING to RUNNING.\n\n### HTTP request\n\n`POST https://{endpoint}/v3/{name=projects/*/locations/*/agents/*/environments/*/experiments/*}:start`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/dialogflow/cx/docs/reference/rest#rest_endpoints).\n\nThe URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Experiment](/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.environments.experiments#Experiment).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/dialogflow`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
