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.
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.
HTTP request
POST https://{endpoint}/v3/{name=projects/*/locations/*/agents/*/flows/*}:validate
[[["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 API call validates a specified flow and creates or updates validation results, which should be called after training is complete to get the full results.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request method is \u003ccode\u003ePOST\u003c/code\u003e to a specific endpoint URL structure: \u003ccode\u003ehttps://{endpoint}/v3/{name=projects/*/locations/*/agents/*/flows/*}:validate\u003c/code\u003e, with the endpoint needing to be one of the supported service endpoints.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e path parameter is required, following the format: \u003ccode\u003eprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>\u003c/code\u003e, with the appropriate IAM permission, \u003ccode\u003edialogflow.flows.validate\u003c/code\u003e, needed for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe request body is in JSON format containing the field \u003ccode\u003elanguageCode\u003c/code\u003e, which if unspecified, will use the agent's default language.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires one of the following OAuth scopes for authorization: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/dialogflow\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.agents.flows.validate\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nValidates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.\n\n### HTTP request\n\n`POST https://{endpoint}/v3/{name=projects/*/locations/*/agents/*/flows/*}:validate`\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 contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [FlowValidationResult](/dialogflow/cx/docs/reference/rest/v3/FlowValidationResult).\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)."]]
