Join the Dialogflow CX competition! Get trained in Dialogflow CX, work on open-source conversational components, get a free Dialogflow t-shirt and win cool prizes! Learn more.

Method: projects.locations.agents.export

Exports the specified agent to a binary file.

HTTP request

POST https://dialogflow.googleapis.com/v3beta1/{name=projects/*/locations/*/agents/*}:export

The URL uses 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,
  "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.

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.