Method: projects.locations.agents.tools.export

Exports the selected tools.

HTTP request

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

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The agent to export tools from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

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

  • dialogflow.tools.list

Request body

The request body contains data with the following structure:

JSON representation
{
  "tools": [
    string
  ],
  "dataFormat": enum (DataFormat),

  // Union field destination can be only one of the following:
  "toolsUri": string,
  "toolsContentInline": boolean
  // End of list of possible types for union field destination.
}
Fields
tools[]

string

Required. The name of the tools to export. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

dataFormat

enum (DataFormat)

Optional. The data format of the exported tools. If not specified, BLOB is assumed.

Union field destination. The destination to export. destination can be only one of the following:
toolsUri

string

Optional. The Google Cloud Storage URI to export the tools to. The format of this URI must be gs://<bucket-name>/<object-name>.

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.

toolsContentInline

boolean

Optional. The option to return the serialized tools inline.

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 tools.

Enums
DATA_FORMAT_UNSPECIFIED Unspecified format. Treated as BLOB.
BLOB Tools will be exported as raw bytes.
JSON Tools will be exported in JSON format.