Method: projects.locations.agents.flows.export

Exports the specified flow to a binary file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.

HTTP request

POST https://{endpoint}/v3/{name=projects/*/locations/*/agents/*/flows/*}: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 flow to export. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

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

  • dialogflow.flows.get

Request body

The request body contains data with the following structure:

JSON representation
{
  "flowUri": string,
  "includeReferencedFlows": boolean
}
Fields
flowUri

string

Optional. The Google Cloud Storage URI to export the flow to. The format of this URI must be gs://<bucket-name>/<object-name>. If left unspecified, the serialized flow 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.

includeReferencedFlows

boolean

Optional. Whether to export flows referenced by the specified flow.

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.