Method: projects.locations.knowledgeBases.documents.export

Exports a smart messaging candidate document into the specified destination.

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

HTTP request

POST https://{endpoint}/v2/{name=projects/*/locations/*/knowledgeBases/*/documents/*}:export

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

The URLs use gRPC Transcoding syntax.

Path parameters



Required. The name of the document to export. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

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

  • dialogflow.documents.get

Request body

The request body contains data with the following structure:

JSON representation
  "exportFullContent": boolean,
  "smartMessagingPartialUpdate": boolean,

  // Union field destination can be only one of the following:
  "gcsDestination": {
    object (GcsDestination)
  // End of list of possible types for union field destination.


When enabled, export the full content of the document including empirical probability.



When enabled, export the smart messaging allowlist document for partial update.

Union field destination. Required. The destination for the export. destination can be only one of the following:

object (GcsDestination)

Cloud Storage file path to export the document.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.