Method: projects.locations.collections.engines.assistants.agents.withdrawAgent

Withdraws an Agent offered to the public. The state of the Agent becomes PRIVATE. Can only be called by the owner of the Agent, regardless of the Agent's state, otherwise it returns an error.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

Request body

The request body must be empty.

Response body

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

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.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.agents.requestReview

For more information, see the IAM documentation.