2026-11-21
▼ ▲ aiplatform.projects.locations.agents.search
Scopes :
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents:search
HTTP Method : GET
Description : Searches the agents in a location that the caller has access to.
Path : v1beta1/{+parent}/agents:search
Parameter Order : parent
Parameters :
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. The maximum number of agents to return. The maximum page size is 100.
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous AgentService.SearchAgents call.
orderBy
Location : query
Type : string
Description : Optional. A comma-separated list of fields to order by, such as `created desc`.
parent
Description : Required. The resource name of the location to search agents in. Format: `projects/{project}/locations/{location}`.
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
filter
Type : string
Location : query
Description : Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents.
▼ ▲ aiplatform.projects.locations.agents.tasks.steer
Parameters :
name
Required : Yes
Description : Required. The name of the task to steer. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Type : string
HTTP Method : POST
Parameter Order : name
Path : v1beta1/{+name}:steer
Description : Steers an existing task without opening a bidirectional stream, either by delivering a follow-up client `input` step (the unary counterpart of connecting to `CreateTaskBidiStream` with `subscribe_task` and sending a `TaskClientEvent` carrying `input`) or by triggering an immediate run of a scheduled task (`trigger_now`). The call returns once the steering action is durably accepted, without waiting for the resulting agent turn or triggered run to complete; observe progress via `StreamTask`. Does not displace an active `CreateTaskBidiStream` participant. Behavior when `input` is set (by task status): * `IDLE`: dispatches a new turn on the task (transitioning it to `WORKING`, or `QUEUED` when deferred admission applies), preserving its prior trajectory, workspace files, approvals, and creation-time `TaskSpec.scope`. * `WORKING` or `QUEUED`: enqueues the input step in arrival order to be delivered to the runtime before its next model call, without aborting an in-flight tool execution. * `REQUIRES_ACTION` or `SUSPENDED`: rejected with `FAILED_PRECONDITION`. Resolve pending elicitations via `ElicitationService` and resume suspended tasks via `ResumeTask`. * Terminal (`COMPLETED`, `FAILED`, `CANCELLED`), scheduled task templates (`Task.spec.schedule` set; steer a concrete spawned run with `input`, or use `trigger_now` on the scheduled task), or live-mode tasks (`INTERACTION_MODE_LIVE`): rejected with `FAILED_PRECONDITION`. Behavior when `trigger_now` is set: * Active scheduled tasks (`Task.spec.schedule.recurring` with `Task.schedule_state` `SCHEDULE_ACTIVE`, or a pending `Task.spec.schedule.one_off` schedule): fires an immediate scheduled run without waiting for `next_run_time` or the remaining delay. * Unscheduled tasks, paused or finished schedules (`SCHEDULE_PAUSED`, `SCHEDULE_FINISHED`), `SUSPENDED` schedules, or terminal tasks: rejected with `FAILED_PRECONDITION`. Steering never widens or mutates `Task.spec.scope`. When invoked by a task workload identity, only the target task's direct parent (`parent_task_id`) may steer it.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:steer
▼ ▲ aiplatform.projects.locations.memoryBanks.create
Parameters :
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks
Path : v1beta1/{+parent}/memoryBanks
HTTP Method : POST
Description : Create a Memory Bank.
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.memoryBanks.get
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$
Location : path
HTTP Method : GET
Path : v1beta1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}
Description : Get a Memory Bank.
Parameter Order : name
▼ ▲ aiplatform.projects.locations.memoryBanks.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}
HTTP Method : PATCH
Description : Update a Memory Bank.
Path : v1beta1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$
Required : Yes
Location : path
Description : Identifier. The resource name of the Memory Bank. Format: `projects/{project}/locations/{location}/memoryBanks/{memory_bank}`
Type : string
updateMask
Location : query
Description : Optional. Mask specifying which fields to update.
Format : google-fieldmask
Type : string
Parameter Order : name
▼ ▲ aiplatform.projects.locations.memoryBanks.retrieveScopes
Description : Retrieves the scopes stored in a Memory Bank.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
pageToken
Type : string
Description : Optional. The standard list page token.
Location : query
parent
Type : string
Location : path
Required : Yes
Description : Required. The parent Memory Bank to retrieve scopes from. Format: `projects/{project}/locations/{location}/memoryBanks/{memory_bank}`
Pattern : ^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$
pageSize
Description : Optional. The maximum number of scopes to return. The service may return fewer than this value. If unspecified, at most 100 scopes will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Type : integer
Location : query
Format : int32
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}:retrieveScopes
Path : v1beta1/{+parent}:retrieveScopes
▼ ▲ aiplatform.projects.locations.memoryBanks.delete
HTTP Method : DELETE
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$
Type : string
Required : Yes
force
Description : Optional. If set to `true`, child resources of this Memory Bank will also be deleted. Otherwise, the request will fail with `FAILED_PRECONDITION` error when the Memory Bank has undeleted child resources.
Location : query
Type : boolean
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}
Path : v1beta1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a Memory Bank.
▼ ▲ aiplatform.projects.locations.memoryBanks.list
HTTP Method : GET
Description : List Memory Banks.
Parameter Order : parent
Parameters :
pageSize
Description : Optional. The maximum number of MemoryBanks to return. The service may return fewer than this value. If unspecified, at most 100 MemoryBanks will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The standard list page token.
Type : string
Location : query
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Path : v1beta1/{+parent}/memoryBanks
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks