# Agent Registry API . projects . locations . agents

## Instance Methods

Close httplib2 connections.

Gets details of a single Agent.

Lists Agents in a given project and location.

Retrieves the next page of results.

Searches Agents in a given project and location.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`get(name, x__xgafv=None)`

    Gets details of a single Agent.

    Args:
      name: string, Required. Name of the resource (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
      "agentId": "A String", # Output only. A stable, globally unique identifier for agents.
      "attributes": { # 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.
        "a_key": {
          "a_key": "", # Properties of the object.
        },
      },
      "card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
        "content": { # Output only. The content of the agent card.
          "a_key": "", # Properties of the object.
        },
        "type": "A String", # Output only. The type of agent card.
      },
      "createTime": "A String", # Output only. Create time.
      "description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
      "displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
      "location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
      "name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
      "protocols": [ # Output only. The connection details for the Agent.
        { # Represents the protocol of an Agent.
          "interfaces": [ # Output only. The connection details for the Agent.
            { # Represents the connection details for an Agent or MCP Server.
              "protocolBinding": "A String", # Required. The protocol binding of the interface.
              "url": "A String", # Required. The destination URL.
            },
          ],
          "protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
          "type": "A String", # Output only. The type of the protocol.
        },
      ],
      "skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
        { # Represents the skills of an Agent.
          "description": "A String", # Output only. A more detailed description of the skill.
          "examples": [ # Output only. Example prompts or scenarios this skill can handle.
            "A String",
          ],
          "id": "A String", # Output only. A unique identifier for the agent's skill.
          "name": "A String", # Output only. A human-readable name for the agent's skill.
          "tags": [ # Output only. Keywords describing the skill.
            "A String",
          ],
        },
      ],
      "uid": "A String", # Output only. A universally unique identifier for the Agent.
      "updateTime": "A String", # Output only. Update time.
      "version": "A 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(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)`

    Lists Agents in a given project and location.

    Args:
      parent: string, Required. Parent value for ListAgentsRequest (required)
      filter: string, Optional. Filtering results
      orderBy: string, Optional. Hint for how to order the results
      pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
      pageToken: string, Optional. A token identifying a page of results the server should return.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Message for response to listing Agents
      "agents": [ # The list of Agents.
        { # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
          "agentId": "A String", # Output only. A stable, globally unique identifier for agents.
          "attributes": { # 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.
            "a_key": {
              "a_key": "", # Properties of the object.
            },
          },
          "card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
            "content": { # Output only. The content of the agent card.
              "a_key": "", # Properties of the object.
            },
            "type": "A String", # Output only. The type of agent card.
          },
          "createTime": "A String", # Output only. Create time.
          "description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
          "displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
          "location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
          "name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
          "protocols": [ # Output only. The connection details for the Agent.
            { # Represents the protocol of an Agent.
              "interfaces": [ # Output only. The connection details for the Agent.
                { # Represents the connection details for an Agent or MCP Server.
                  "protocolBinding": "A String", # Required. The protocol binding of the interface.
                  "url": "A String", # Required. The destination URL.
                },
              ],
              "protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
              "type": "A String", # Output only. The type of the protocol.
            },
          ],
          "skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
            { # Represents the skills of an Agent.
              "description": "A String", # Output only. A more detailed description of the skill.
              "examples": [ # Output only. Example prompts or scenarios this skill can handle.
                "A String",
              ],
              "id": "A String", # Output only. A unique identifier for the agent's skill.
              "name": "A String", # Output only. A human-readable name for the agent's skill.
              "tags": [ # Output only. Keywords describing the skill.
                "A String",
              ],
            },
          ],
          "uid": "A String", # Output only. A universally unique identifier for the Agent.
          "updateTime": "A String", # Output only. Update time.
          "version": "A 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.
        },
      ],
      "nextPageToken": "A String", # A token identifying a page of results the server should return.
    }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.

`search(parent, body=None, x__xgafv=None)`

    Searches Agents in a given project and location.

    Args:
      parent: string, Required. Parent value for SearchAgentsRequest. Format: `projects/{project}/locations/{location}`. (required)
      body: object, The request body.
        The object takes the form of:

    { # Message for searching Agents
      "pageSize": 42, # Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.
      "pageToken": "A String", # Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.
      "searchString": "A String", # Optional. Search criteria used to select the Agents to return. If no search criteria is specified then all accessible Agents will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | agentId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | skills | No | Yes | No | Included | | skills.id | No | Yes | No | Included | | skills.name | No | Yes | No | Included | | skills.description | No | Yes | No | Included | | skills.tags | No | Yes | No | Included | | skills.examples | No | Yes | No | Included | Examples: * `agentId="urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234"` to find the agent with the specified agent ID. * `name:important` to find agents whose name contains `important` as a word. * `displayName:works*` to find agents whose display name contains words that start with `works`. * `skills.tags:test` to find agents whose skills tags contain `test`. * `planner OR booking` to find agents whose metadata contains the words `planner` or `booking`.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Message for response to searching Agents
      "agents": [ # A list of Agents that match the `search_string`.
        { # Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
          "agentId": "A String", # Output only. A stable, globally unique identifier for agents.
          "attributes": { # 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.
            "a_key": {
              "a_key": "", # Properties of the object.
            },
          },
          "card": { # Full Agent Card payload, often obtained from the A2A Agent Card. # Output only. Full Agent Card payload, when available.
            "content": { # Output only. The content of the agent card.
              "a_key": "", # Properties of the object.
            },
            "type": "A String", # Output only. The type of agent card.
          },
          "createTime": "A String", # Output only. Create time.
          "description": "A String", # Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
          "displayName": "A String", # Output only. The display name of the agent, often obtained from the A2A Agent Card.
          "location": "A String", # Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
          "name": "A String", # Identifier. The resource name of an Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
          "protocols": [ # Output only. The connection details for the Agent.
            { # Represents the protocol of an Agent.
              "interfaces": [ # Output only. The connection details for the Agent.
                { # Represents the connection details for an Agent or MCP Server.
                  "protocolBinding": "A String", # Required. The protocol binding of the interface.
                  "url": "A String", # Required. The destination URL.
                },
              ],
              "protocolVersion": "A String", # Output only. The version of the protocol, for example, the A2A Agent Card version.
              "type": "A String", # Output only. The type of the protocol.
            },
          ],
          "skills": [ # Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
            { # Represents the skills of an Agent.
              "description": "A String", # Output only. A more detailed description of the skill.
              "examples": [ # Output only. Example prompts or scenarios this skill can handle.
                "A String",
              ],
              "id": "A String", # Output only. A unique identifier for the agent's skill.
              "name": "A String", # Output only. A human-readable name for the agent's skill.
              "tags": [ # Output only. Keywords describing the skill.
                "A String",
              ],
            },
          ],
          "uid": "A String", # Output only. A universally unique identifier for the Agent.
          "updateTime": "A String", # Output only. Update time.
          "version": "A 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.
        },
      ],
      "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
    }

`search_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.