agents

Creates, updates, deletes, gets or lists an agents resource.

Overview

Name	agents
Type	Resource
Id	google.agentregistry.agents

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of an Agent. Format: projects/{project}/locations/{location}/agents/{agent}.
agentId	string	Output only. A stable, globally unique identifier for agents.
attributes	object	Output only. Attributes of the Agent. Valid values: * agentregistry.googleapis.com/system/Framework: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * agentregistry.googleapis.com/system/RuntimeIdentity: {"principal": "principal://..."} - the runtime identity associated with the Agent. * agentregistry.googleapis.com/system/RuntimeReference: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
card	object	Output only. Full Agent Card payload, when available. (id: Card)
createTime	string (google-datetime)	Output only. Create time.
description	string	Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
displayName	string	Output only. The display name of the agent, often obtained from the A2A Agent Card.
location	string	Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
protocols	array	Output only. The connection details for the Agent.
skills	array	Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
uid	string	Output only. A universally unique identifier for the Agent.
updateTime	string (google-datetime)	Output only. Update time.
version	string	Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.

list

Name	Datatype	Description
name	string	Identifier. The resource name of an Agent. Format: projects/{project}/locations/{location}/agents/{agent}.
agentId	string	Output only. A stable, globally unique identifier for agents.
attributes	object	Output only. Attributes of the Agent. Valid values: * agentregistry.googleapis.com/system/Framework: {"framework": "google-adk"} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * agentregistry.googleapis.com/system/RuntimeIdentity: {"principal": "principal://..."} - the runtime identity associated with the Agent. * agentregistry.googleapis.com/system/RuntimeReference: {"uri": "//..."} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
card	object	Output only. Full Agent Card payload, when available. (id: Card)
createTime	string (google-datetime)	Output only. Create time.
description	string	Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
displayName	string	Output only. The display name of the agent, often obtained from the A2A Agent Card.
location	string	Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
protocols	array	Output only. The connection details for the Agent.
skills	array	Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
uid	string	Output only. A universally unique identifier for the Agent.
updateTime	string (google-datetime)	Output only. Update time.
version	string	Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, agentsId		Gets details of a single Agent.
list	select	projectsId, locationsId	filter, pageSize, pageToken, orderBy	Lists Agents in a given project and location.
search	exec	projectsId, locationsId		Searches Agents in a given project and location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets details of a single Agent.

SELECT
name,
agentId,
attributes,
card,
createTime,
description,
displayName,
location,
protocols,
skills,
uid,
updateTime,
version
FROM google.agentregistry.agents
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
;

list

Lists Agents in a given project and location.

SELECT
name,
agentId,
attributes,
card,
createTime,
description,
displayName,
location,
protocols,
skills,
uid,
updateTime,
version
FROM google.agentregistry.agents
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
;

Lifecycle Methods

search

Searches Agents in a given project and location.

EXEC google.agentregistry.agents.search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"pageSize": {{ pageSize }}, 
"searchString": "{{ searchString }}", 
"pageToken": "{{ pageToken }}"
}'
;