Method: projects.locations.collections.engines.agents.deploy

Deploys an Agent.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/agents/*}:deploy

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of Agent. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "force": boolean
}
Fields
force

boolean

Optional. If true, force to redeploy the deployed agent.

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/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

For more information, see the Authentication Overview.