GOgoogle
projects

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

Changed on

Retrieves an agent.

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
agentsIdstring required

Response

Successful response

aiApplicationstring

Output only. The resource name of the AI Application provisioned for this agent. Format: projects/{project}/locations/{location}/aiApplications/{ai_application}.

base_agentstring

Required. Immutable. The base agent for the agent. Supported values: * antigravity-preview-05-2026 Immutable: UpdateAgent rejects a change, including clearing it. The kind of agent this is gets derived from this field when the agent is created and is recorded then; nothing recomputes it afterwards, so a later change would leave the agent described as one kind and behaving as another. Create a new agent instead.

base_environmentunknown
createdstring google-datetime

Output only. The time the agent was created.

descriptionstring

Optional. The description of the agent.

effectiveIdentitystring

Output only. The resolved Agent Identity (SPIFFE principal) of the agent.

idstring

Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

metadataobject

Optional. The metadata for the agent.

namestring

Identifier. The resource name of the agent. Format: projects/{project}/locations/{location}/agents/{agent}.

objectstring

Output only. The object type of the resource. For agents, the value is agent.

system_instructionstring

Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.

updatedstring google-datetime

Output only. The time the agent was last updated.

Changes

  • 3aca3b348f0cRevision 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

  • 34fcc627b062Revision 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