Method: projects.locations.agents.restore

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The name of the agent to restore into. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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

  • dialogflow.agents.restore

Request body

The request body contains data with the following structure:

JSON representation

  // Union field agent can be only one of the following:
  "agentUri": string,
  "agentContent": string
  // End of list of possible types for union field agent.
Union field agent. Required. The agent to restore. agent can be only one of the following:


The Google Cloud Storage URI to restore agent from. The format of this URI must be gs://<bucket-name>/<object-name>.


string (bytes format)

Uncompressed raw byte content for agent.

A base64-encoded string.

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.