Method: projects.locations.agents.export

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:

HTTP request

POST https://{endpoint}/v3beta1/{name=projects/*/locations/*/agents/*}:export

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the agent to export. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.agents.export

Request body

The request body contains data with the following structure:

JSON representation
{
  "agentUri": string,
  "dataFormat": enum (DataFormat),
  "environment": string
}
Fields
agentUri

string

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.

dataFormat

enum (DataFormat)

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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

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.