Method: projects.knowledgeBases.documents.reload

Stay organized with collections Save and categorize content based on your preferences.

Reloads the specified document from its specified source, contentUri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes.

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

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

HTTP request

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

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

The URLs use gRPC Transcoding syntax.

Path parameters



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

Request body

The request body contains data with the following structure:

JSON representation
  "importGcsCustomMetadata": boolean,
  "smartMessagingPartialUpdate": boolean,
  "contentUri": string


Optional. Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.



Optional. When enabled, the reload request is to apply partial update to the smart messaging allowlist.



Optional. The path of gcs source file for reloading document content. For now, only gcs uri is supported.

For documents stored in Google Cloud Storage, these URIs must have the form gs://<bucket-name>/<object-name>.

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.