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

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions

Updates an Agent

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
agent.name	string Identifier. Resource name of the agent. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} or projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}

Query parameters

Parameters
updateMask	string (FieldMask format) Optional. The list of fields to update. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Agent.

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.update

For more information, see the IAM documentation.