2026-06-18
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.pause
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Description : Pauses the specific SandboxEnvironment.
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:pause
Path : v1/{+name}:pause
Parameters :
name
Location : path
Description : Required. The resource name of the sandbox environment to pause. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Required : Yes
Type : string
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.resume
Path : v1/{+name}:resume
Parameters :
name
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Location : path
Description : Required. The resource name of the sandbox environment to resume. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Type : string
Required : Yes
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:resume
HTTP Method : POST
Description : Resumes the specific SandboxEnvironment.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.projects.locations.evaluationSets.import
Path : v1/{+parent}/evaluationSets:import
Parameters :
parent
Required : Yes
Type : string
Description : Required. Parent resource name.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/evaluationSets:import
HTTP Method : POST
Description : Imports an Evaluation Set.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.pause
Path : v1/{+name}:pause
Parameters :
name
Description : Required. The resource name of the sandbox environment to pause. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Required : Yes
Type : string
HTTP Method : POST
Description : Pauses the specific SandboxEnvironment.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:pause
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.resume
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Description : Resumes the specific SandboxEnvironment.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:resume
Path : v1/{+name}:resume
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Description : Required. The resource name of the sandbox environment to resume. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Location : path
Type : string
Required : Yes
▼ ▲ aiplatform.projects.locations.onlineEvaluators.operations.cancel
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel
Path : v1/{+name}:cancel
Parameters :
name
Required : Yes
Type : string
Description : The name of the operation resource to be cancelled.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$
▼ ▲ aiplatform.projects.locations.onlineEvaluators.operations.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}
HTTP Method : GET
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Location : path
Type : string
Required : Yes
▼ ▲ aiplatform.projects.locations.onlineEvaluators.operations.list
Path : v1/{+name}/operations
Parameters :
pageSize
Type : integer
Description : The standard list page size.
Location : query
Format : int32
returnPartialSuccess
Type : boolean
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
filter
Type : string
Description : The standard list filter.
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$
Description : The name of the operation's parent resource.
Location : path
Type : string
Required : Yes
pageToken
Type : string
Description : The standard list page token.
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations
HTTP Method : GET
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.projects.locations.onlineEvaluators.operations.wait
Path : v1/{+name}:wait
Parameters :
name
Required : Yes
Type : string
Location : path
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$
timeout
Type : string
Location : query
Format : google-duration
Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
HTTP Method : POST
Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait
Parameter Order : name
▼ ▲ aiplatform.projects.locations.onlineEvaluators.operations.delete
Path : v1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Location : path
Type : string
Required : Yes
HTTP Method : DELETE
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}
Parameter Order : name
▼ ▲ aiplatform.projects.locations.onlineEvaluators.create
Path : v1/{+parent}/onlineEvaluators
Parameters :
parent
Location : path
Description : Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project}/locations/{location}.
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators
HTTP Method : POST
Description : Creates an OnlineEvaluator in the given project and location.
▼ ▲ aiplatform.projects.locations.onlineEvaluators.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators
HTTP Method : GET
Description : Lists the OnlineEvaluators for the given project and location.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1/{+parent}/onlineEvaluators
Parameters :
parent
Location : path
Description : Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project}/locations/{location}.
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 100 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158.
Location : query
Format : int32
Type : integer
filter
Location : query
Description : Optional. Standard list filter. Supported fields: * `create_time` * `update_time` * `agent_resource` Example: `create_time>"2026-01-01T00:00:00-04:00"` where the timestamp is in RFC 3339 format) Based on aip.dev/160.
Type : string
pageToken
Type : string
Location : query
Description : Optional. A token identifying a page of results the server should return. Based on aip.dev/158.
orderBy
Type : string
Description : Optional. A comma-separated list of fields to order by. The default sorting order is ascending. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. Based on aip.dev/132.
Location : query
▼ ▲ aiplatform.projects.locations.onlineEvaluators.suspend
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Description : Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:suspend
Path : v1/{+name}:suspend
Parameters :
name
Description : Required. The name of the OnlineEvaluator to suspend. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$
Required : Yes
Type : string
▼ ▲ aiplatform.projects.locations.onlineEvaluators.delete
Path : v1/{+name}
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$
Description : Required. The name of the OnlineEvaluator to delete. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
Location : path
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}
HTTP Method : DELETE
Description : Deletes an OnlineEvaluator.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.projects.locations.onlineEvaluators.patch
Path : v1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$
Description : Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
Location : path
Type : string
Required : Yes
updateMask
Location : query
Format : google-fieldmask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Description : Updates the fields of an OnlineEvaluator.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}
▼ ▲ aiplatform.projects.locations.onlineEvaluators.get
Path : v1/{+name}
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$
Location : path
Description : Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}
HTTP Method : GET
Description : Gets details of an OnlineEvaluator.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.projects.locations.onlineEvaluators.activate
Path : v1/{+name}:activate
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$
Description : Required. The name of the OnlineEvaluator to activate. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
Location : path
Type : string
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:activate
HTTP Method : POST
Description : Activates an OnlineEvaluator.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.projects.locations.generateLossClusters
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : location
Flat Path : v1/projects/{projectsId}/locations/{locationsId}:generateLossClusters
HTTP Method : POST
Description : Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource.
Path : v1/{+location}:generateLossClusters
Parameters :
location
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The resource name of the Location. Format: `projects/{project}/locations/{location}`
Location : path
Type : string
Required : Yes
▼ ▲ aiplatform.projects.locations.generateUserScenarios
Flat Path : v1/projects/{projectsId}/locations/{locationsId}:generateUserScenarios
HTTP Method : POST
Description : Generates user scenarios for agent evaluation.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : location
Path : v1/{+location}:generateUserScenarios
Parameters :
location
Required : Yes
Type : string
Location : path
Description : Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
▼ ▲ aiplatform.onlineEvaluators.operations.get
Path : v1/{+name}
Parameters :
name
Required : Yes
Type : string
Location : path
Description : The name of the operation resource.
Pattern : ^onlineEvaluators/[^/]+/operations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}
HTTP Method : GET
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ aiplatform.onlineEvaluators.operations.cancel
Path : v1/{+name}:cancel
Parameters :
name
Description : The name of the operation resource to be cancelled.
Location : path
Pattern : ^onlineEvaluators/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel
HTTP Method : POST
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
▼ ▲ aiplatform.onlineEvaluators.operations.delete
Path : v1/{+name}
Parameters :
name
Pattern : ^onlineEvaluators/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource to be deleted.
Type : string
Required : Yes
Flat Path : v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}
HTTP Method : DELETE
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.onlineEvaluators.operations.list
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/onlineEvaluators/{onlineEvaluatorsId}/operations
Path : v1/{+name}/operations
Parameters :
name
Required : Yes
Type : string
Description : The name of the operation's parent resource.
Location : path
Pattern : ^onlineEvaluators/[^/]+$
pageToken
Type : string
Description : The standard list page token.
Location : query
returnPartialSuccess
Type : boolean
Location : query
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
filter
Type : string
Description : The standard list filter.
Location : query
pageSize
Type : integer
Location : query
Format : int32
Description : The standard list page size.
▼ ▲ aiplatform.onlineEvaluators.operations.wait
Path : v1/{+name}:wait
Parameters :
name
Required : Yes
Type : string
Location : path
Description : The name of the operation resource to wait on.
Pattern : ^onlineEvaluators/[^/]+/operations/[^/]+$
timeout
Location : query
Format : google-duration
Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type : string
HTTP Method : POST
Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path : v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait
Parameter Order : name