projects

GET /v1/projects/{projectsId}/locations/{locationsId}/agents

Changed on

Lists the agents in a location that belong to the caller. An agent belongs to the end user recorded as its owner when it was created, so the response holds that caller's agents and no others. It is empty for a caller that is not an end user, and an agent with no recorded owner is listed for nobody.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/aiplatform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/aiplatform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required

Query parameters

filterstring

Optional. An AIP-160 filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields, and the operators each accepts: * created * updated * base_agent * metadata.agent_type created and updated are timestamps and take an RFC-3339 value, for example 2026-08-01T00:00:00Z. Supported operators: =, !=, <, >, <=, >=, :, AND, OR, NOT (equivalently -), and parentheses. Note that OR binds more tightly than AND, so a AND b OR c means a AND (b OR c); parentheses are recommended, not required. metadata.agent_type accepts only the value "default_agent", matched exactly: metadata.agent_type:"default_agent" selects the caller's default agent, of which there is at most one, and the negated form selects the rest. Any other value is INVALID_ARGUMENT rather than an empty page -- metadata is an opaque blob, so only this one marker is indexed, and the server cannot answer a question about the others. An agent designated before the server began recording the marker is not matched by the positive form; there is no backfill. base_agent accepts = and != against the value an agent was created with, and selects only among the agents you own: an agent that belongs to the project rather than to a user is never returned by a filter naming it, including the negated form. An agent created before the server began recording the value is not matched either. Example: created > "2026-08-01T00:00:00Z" AND updated < "2026-08-09T00:00:00Z". IMPORTANT -- base_agent and metadata.agent_type select only among the agents you own. An agent that belongs to the project rather than to a user is never returned by a filter naming either of them, including a negated one: base_agent != "some-value" returns your matching agents and no project-owned agents at all. Filtering on created or updated alone is unaffected and still spans both. If you want every agent in the project, do not filter on these two fields. Not supported: any field other than those listed above, wildcards other than field:*, bare literals with no field name, functions, and the regular-expression operators =~ and !~. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with INVALID_ARGUMENT.

orderBystring

Optional. A comma-separated list of fields to order by. Supported fields: * created * updated Use desc after a field name for descending order. Example: created desc.

pageSizeinteger

Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10.

pageTokenstring

Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page.

Response

Successful response

nextPageTokenstring

A token to retrieve the next page of results. Pass this value as ListAgentsRequest.page_token in a subsequent call.

Changes

    • info

      the security scope https://www.googleapis.com/auth/aiplatform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/aiplatform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/aiplatform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/aiplatform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was removed from the endpoint's security scheme Oauth2c