projects

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

Changed on Nov 6, 2026

Creates 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

Request body

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.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes

Nov 6, 20263aca3b348f0c Revision 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
Oct 30, 202634fcc627b062 Revision changes
- warning
  deleted the query request parameter idpNonce
- 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

Operation history