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.
Optional. The Google Cloud Storage URI to export the agent to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized agent is returned inline.
Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.
Optional. The data format of the exported agent. If not specified, BLOB is assumed.
environment
string
Optional. Environment name. If not set, draft environment is assumed. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>.
[[["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 document outlines how to export an agent to a binary file using a long-running operation, detailing the process and required parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a POST method to a specific endpoint, with the agent's name as a required path parameter for identification.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can include options like a Google Cloud Storage URI for agent export, the data format (\u003ccode\u003eBLOB\u003c/code\u003e or \u003ccode\u003eJSON_PACKAGE\u003c/code\u003e), the target environment, Git branch destination details, and whether to include BigQuery export settings.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful export operations return an \u003ccode\u003eOperation\u003c/code\u003e instance, while the export process requires specific IAM permissions and OAuth scopes for authentication.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGitDestination\u003c/code\u003e field allows exporting the agent to a specific git branch with a provided commit message, and requires a tracking branch for the push.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.agents.export\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- [DataFormat](#DataFormat)\n- [GitDestination](#GitDestination)\n - [JSON representation](#GitDestination.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nExports the specified agent to a binary file.\n\nThis 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:\n\n- `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)\n- `response`: [ExportAgentResponse](/dialogflow/cx/docs/reference/rest/v3/ExportAgentResponse)\n\n### HTTP request\n\n`POST https://{endpoint}/v3/{name=projects/*/locations/*/agents/*}:export`\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 [Operation](/dialogflow/cx/docs/reference/rest/v3/projects.locations.operations#Operation).\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).\n\nDataFormat\n----------\n\nData format of the exported agent.\n\nGitDestination\n--------------\n\nSettings for exporting to a git branch."]]
