2026-06-14
▼ ▲ aiplatform.projects.locations.agentAnomalyDetectionScopes.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : Required. The name of the AgentAnomalyDetectionScope resource to be deleted. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agentAnomalyDetectionScopes/[^/]+$
Required : Yes
Path : v1beta1/{+name}
Description : Deletes a specific AgentAnomalyDetectionScope.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes/{agentAnomalyDetectionScopesId}
HTTP Method : DELETE
Parameter Order : name
▼ ▲ aiplatform.projects.locations.agentAnomalyDetectionScopes.get
Parameters :
name
Description : Required. The name of the AgentAnomalyDetectionScope resource. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agentAnomalyDetectionScopes/[^/]+$
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the details of a specific AgentAnomalyDetectionScope.
Path : v1beta1/{+name}
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes/{agentAnomalyDetectionScopesId}
▼ ▲ aiplatform.projects.locations.agentAnomalyDetectionScopes.create
Description : Creates a new AgentAnomalyDetectionScope.
Path : v1beta1/{+parent}/agentAnomalyDetectionScopes
Parameter Order : parent
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes
Parameters :
agentAnomalyDetectionScopeId
Description : Required. The ID to use for the AgentAnomalyDetectionScope, which will become the final component of the AgentAnomalyDetectionScope's resource name. This value should be 1-63 characters, and valid characters are /[a-z]([a-z0-9-]{0,61}[a-z0-9])?/.
Type : string
Location : query
parent
Description : Required. The resource name of the Location to create the AgentAnomalyDetectionScope in. Format: `projects/{project}/locations/{location}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
▼ ▲ aiplatform.projects.locations.agentAnomalyDetectionScopes.patch
Description : Updates an existing AgentAnomalyDetectionScope.
Path : v1beta1/{+name}
Parameter Order : name
HTTP Method : PATCH
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes/{agentAnomalyDetectionScopesId}
Parameters :
updateMask
Location : query
Format : google-fieldmask
Description : Optional. The list of fields to update. Supported paths: `display_name`, `auto_enroll`, `log_buckets`, `observability_buckets`.
Type : string
name
Location : path
Description : Identifier. The resource name of the AgentAnomalyDetectionScope. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agentAnomalyDetectionScopes/[^/]+$
Required : Yes
▼ ▲ aiplatform.projects.locations.agentAnomalyDetectionScopes.list
Parameters :
parent
Description : Required. The resource name of the Location to list the AgentAnomalyDetectionScopes from. Format: `projects/{project}/locations/{location}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
pageSize
Description : Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 AgentAnomalyDetectionScopes will be returned.
Type : integer
Location : query
Format : int32
pageToken
Description : Optional. The standard list page token.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes
Description : Lists AgentAnomalyDetectionScopes in a Location.
Path : v1beta1/{+parent}/agentAnomalyDetectionScopes
▼ ▲ aiplatform.projects.locations.monitoredAgents.delete
Path : v1beta1/{+name}
Description : Deletes a specific MonitoredAgent.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}
HTTP Method : DELETE
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The name of the MonitoredAgent resource to be deleted. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Required : Yes
▼ ▲ aiplatform.projects.locations.monitoredAgents.get
Path : v1beta1/{+name}
Description : Gets the details of a specific MonitoredAgent.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}
HTTP Method : GET
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The name of the MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Required : Yes
▼ ▲ aiplatform.projects.locations.monitoredAgents.enable
Path : v1beta1/{+name}:enable
Description : Enables a specific MonitoredAgent.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:enable
HTTP Method : POST
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Required : Yes
Location : path
Description : Required. The name of the MonitoredAgent resource to be enabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Type : string
▼ ▲ aiplatform.projects.locations.monitoredAgents.create
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents
HTTP Method : POST
Parameter Order : parent
Path : v1beta1/{+parent}/monitoredAgents
Description : Creates a new MonitoredAgent in a specific Location.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
monitoredAgentId
Description : Required. The ID to use for the MonitoredAgent, which will become the final component of the MonitoredAgent's resource name.
Type : string
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Location : path
Description : Required. The resource name of the Location to create the MonitoredAgent in. Format: `projects/{project}/locations/{location}`
Type : string
▼ ▲ aiplatform.projects.locations.monitoredAgents.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
filter
Location : query
Description : Optional. Optional AIP-160 filter, currently restricted to a single equality predicate on `state`: state = ACTIVE state = DISABLED state = ENABLING The value must be the exact name of a `MonitoredAgent.EnablementState` constant (case-sensitive): `ACTIVE`, `DISABLED`, `ENABLING`, or `ENABLEMENT_STATE_UNSPECIFIED`. (The proto reserves ordinals for additional future states like NEEDS_ACTION; this allow-list grows when the proto adds them.) A blank or absent filter returns every MonitoredAgent in the parent regardless of state. Anything else returns INVALID_ARGUMENT.
Type : string
parent
Location : path
Description : Required. The resource name of the Location to list the MonitoredAgents from. Format: `projects/{project}/locations/{location}`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
pageSize
Description : Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned.
Type : integer
Location : query
Format : int32
pageToken
Description : Optional. The standard list page token.
Type : string
Location : query
Path : v1beta1/{+parent}/monitoredAgents
Description : Lists MonitoredAgents in a specific Location.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents
HTTP Method : GET
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.monitoredAgents.disable
Path : v1beta1/{+name}:disable
Description : Disables a specific MonitoredAgent.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:disable
HTTP Method : POST
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : Required. The name of the MonitoredAgent resource to be disabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Required : Yes
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+$
Required : Yes
Location : path
Description : Required. The name of the AnalyzedSession resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}`
Type : string
view
Description : Optional. Resource view to control which fields are returned.
Type : string
Location : query
Enum Descriptions :
Enum :
Path : v1beta1/{+name}
Description : Gets the details of a specific AnalyzedSession.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}
Parameter Order : name
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.list
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions
Parameter Order : parent
HTTP Method : GET
Path : v1beta1/{+parent}/analyzedSessions
Description : Lists AnalyzedSessions in a MonitoredAgent.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Required : Yes
Description : Required. The parent MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Type : string
Location : path
pageSize
Location : query
Format : int32
Description : Optional. The maximum number of analyzed sessions to return.
Type : integer
orderBy
Description : Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append " desc" to a field to sort descending. Subfields are not supported (no field listed below has any). Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. This is the column the landing page's "Detection time" header sorts on. Sorted by the underlying TIMESTAMP value (newer is "greater" so `latest_detection_time desc` puts the newest sessions first). * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4 (matches `Severity` enum ordering). `max_severity_rank desc` puts the most-severe sessions first. The ranking is documented here per AIP-132 because the field is not a natural-comparator type. The server always appends `session_id ASC` as a stable tiebreak so pagination remains consistent across pages when the primary sort field has duplicates (e.g. multiple sessions with the same latest_detection_time within a second). If empty, defaults to `latest_detection_time desc` (the prior implicit behavior). Multi-field sort (e.g. `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT.
Type : string
Location : query
filter
Description : Optional. Filter expression restricting which AnalyzedSessions are returned. A subset of AIP-160 supporting two clauses joined by AND: 1. A closed time window on `detection_time`. If included, both bounds are required: detection_time >= "" AND detection_time <= "" 2. An equality on `severity`, where the value is the string representation of a Severity enum value (e.g., "CRITICAL", "HIGH", "MEDIUM", "LOW"). "SEVERITY_UNSPECIFIED" is not supported. The filter matches sessions whose maximum severity equals the requested bucket (a session whose detectors fire at LOW and CRITICAL is matched by `severity = "CRITICAL"`, not `severity = "LOW"`): severity = "CRITICAL" Both clauses are independently optional and may appear in either order. Each clause may appear at most once. Example (time window + severity): detection_time >= "2024-01-01T00:00:00Z" AND detection_time <= "2024-01-08T00:00:00Z" AND severity = "CRITICAL" If empty, results are restricted to the last 3 days with no severity restriction. Other fields, additional operators, set membership (IN), and boolean combinations (OR, NOT, parentheses) are not yet supported.
Type : string
Location : query
pageToken
Description : Optional. A page token, received from a previous `ListAnalyzedSessions` call.
Type : string
Location : query
view
Description : Optional. Resource view to control which fields are returned.
Type : string
Location : query
Enum Descriptions :
Enum :
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.aggregate
Parameters :
pageToken
Location : query
Description : Optional. The standard list page token.
Type : string
parent
Location : path
Description : Required. The parent MonitoredAgent resource. Use the `-` wildcard for the monitored_agent segment to aggregate across multiple agents in the location. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$
Required : Yes
pageSize
Description : Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned.
Type : integer
Location : query
Format : int32
filter
Location : query
Description : Optional. Filter expression restricting which AnalyzedSessions are included in the aggregation. Uses a subset of the `ListAnalyzedSessionsRequest.filter` grammar: a closed `detection_time` window with both bounds required, e.g. detection_time >= "2024-01-01T00:00:00Z" AND detection_time <= "2024-01-08T00:00:00Z" The `severity` clause supported on ListAnalyzedSessions is intentionally rejected here: this response groups by severity (one entry per bucket per agent), so a severity filter would collapse the rollup to a single bucket and produce a misleading per-agent view. If empty, the aggregation covers the last 3 days.
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions:aggregate
Description : Aggregates AnalyzedSessions across MonitoredAgents. To aggregate across all MonitoredAgents in a location, use the following format for the parent field: `projects/{project}/locations/{location}/monitoredAgents/-`
Path : v1beta1/{+parent}/analyzedSessions:aggregate
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+/analyzedInvocations/[^/]+$
Required : Yes
Description : Required. The name of the AnalyzedInvocation resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}/analyzedInvocations/{analyzed_invocation}`
Type : string
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the details of a specific AnalyzedInvocation.
Path : v1beta1/{+name}
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}/analyzedInvocations/{analyzedInvocationsId}
▼ ▲ aiplatform.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+$
Required : Yes
Location : path
Description : Required. The parent AnalyzedSession resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}`
Type : string
pageSize
Description : Optional. The maximum number of analyzed invocations to return.
Type : integer
Location : query
Format : int32
pageToken
Description : Optional. A page token, received from a previous `ListAnalyzedInvocations` call.
Type : string
Location : query
Path : v1beta1/{+parent}/analyzedInvocations
Description : Lists AnalyzedInvocations in a MonitoredAgent's AnalyzedSession.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}/analyzedInvocations
HTTP Method : GET
Parameter Order : parent
▼ ▲ aiplatform.interactions.getPoll
Parameters :
lastEventId
Location : query
Description : Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
Type : string
includeInput
Deprecated : Yes
Description : Optional. If true, includes the input in the response.
Type : boolean
Location : query
last_event_id
Description : Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
Location : query
Type : string
include_input
Description : Optional. If true, includes the input in the response.
Location : query
Deprecated : Yes
Type : boolean
▼ ▲ aiplatform.interactions.getStream
Parameters :
lastEventId
Description : Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
Type : string
Location : query
includeInput
Deprecated : Yes
Description : Optional. If true, includes the input in the response.
Type : boolean
Location : query
last_event_id
Description : Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
Location : query
Type : string
include_input
Description : Optional. If true, includes the input in the response.
Location : query
Deprecated : Yes
Type : boolean