- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- DataFormat
- GitDestination
- Try it!
Exports the specified agent to a binary file.
This method is a long-running operation. The returned Operation
type has the following method-specific fields:
metadata
: An empty Struct messageresponse
:ExportAgentResponse
HTTP request
POST https://{endpoint}/v3/{name=projects/*/locations/*/agents/*}:export
Where {endpoint}
is one of the supported service endpoints.
The URLs use gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the agent to export. Format: Authorization requires the following IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "agentUri": string, "dataFormat": enum ( |
Fields | |
---|---|
agent |
Optional. The Google Cloud Storage URI to export the agent to. The format of this URI must be 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. |
data |
Optional. The data format of the exported agent. If not specified, |
environment |
Optional. Environment name. If not set, draft environment is assumed. Format: |
git |
Optional. The Git branch to export the agent to. |
include |
Optional. Whether to include BigQuery Export setting. |
Response body
If successful, the response body contains an instance of Operation
.
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.
DataFormat
Data format of the exported agent.
Enums | |
---|---|
DATA_FORMAT_UNSPECIFIED |
Unspecified format. |
BLOB |
Agent content will be exported as raw bytes. |
JSON_PACKAGE |
Agent content will be exported in JSON Package format. |
GitDestination
Settings for exporting to a git branch.
JSON representation |
---|
{ "trackingBranch": string, "commitMessage": string } |
Fields | |
---|---|
tracking |
Tracking branch for the git push. |
commit |
Commit message for the git push. |