REST Resource: projects.locations.agents

Resource: Agent

Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.

JSON representation
{
  "name": string,
  "agentId": string,
  "location": string,
  "displayName": string,
  "description": string,
  "version": string,
  "protocols": [
    {
      object (Protocol)
    }
  ],
  "skills": [
    {
      object (Skill)
    }
  ],
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "attributes": {
    string: {
      object
    },
    ...
  },
  "card": {
    object (Card)
  }
}
Fields
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.

location

string

Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).

displayName

string

Output only. The display name of the agent, often obtained from the A2A Agent Card.

description

string

Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.

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.

protocols[]

object (Protocol)

Output only. The connection details for the Agent.

skills[]

object (Skill)

Output only. Skills the agent possesses, often obtained from the A2A Agent Card.

uid

string

Output only. A universally unique identifier for the Agent.

createTime

string (Timestamp format)

Output only. Create time.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. Update time.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

attributes

map (key: string, value: object (Struct format))

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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

card

object (Card)

Output only. Full Agent Card payload, when available.

Protocol

Represents the protocol of an Agent.

JSON representation
{
  "type": enum (Type),
  "protocolVersion": string,
  "interfaces": [
    {
      object (Interface)
    }
  ]
}
Fields
type

enum (Type)

Output only. The type of the protocol.

protocolVersion

string

Output only. The version of the protocol, for example, the A2A Agent Card version.

interfaces[]

object (Interface)

Output only. The connection details for the Agent.

Type

The type of the protocol.

Enums
TYPE_UNSPECIFIED Unspecified type.
A2A_AGENT The interfaces point to an A2A Agent following the A2A specification.
CUSTOM Agent does not follow any standard protocol.

Skill

Represents the skills of an Agent.

JSON representation
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ]
}
Fields
id

string

Output only. A unique identifier for the agent's skill.

name

string

Output only. A human-readable name for the agent's skill.

description

string

Output only. A more detailed description of the skill.

tags[]

string

Output only. Keywords describing the skill.

examples[]

string

Output only. Example prompts or scenarios this skill can handle.

Card

Full Agent Card payload, often obtained from the A2A Agent Card.

JSON representation
{
  "type": enum (Type),
  "content": {
    object
  }
}
Fields
type

enum (Type)

Output only. The type of agent card.

content

object (Struct format)

Output only. The content of the agent card.

Type

Represents the type of the agent card.

Enums
TYPE_UNSPECIFIED Unspecified type.
A2A_AGENT_CARD Indicates that the card is an A2A Agent Card.

Methods

get

Gets details of a single Agent.

list

Lists Agents in a given project and location.
Searches Agents in a given project and location.