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

Rejects an Agent offered to the public. The state of the Agent becomes PRIVATE. Can be called on an Agent in the state DISABLED, otherwise it returns an error.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

Query parameters

Parameters
rejectionReason

string

Required. The reason for rejecting the 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.