2025-12-19
▼ ▲ aiplatform.reasoningEngines.executeCode
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/reasoningEngines/{reasoningEnginesId}:executeCode
Path : v1/{+name}:executeCode
Parameter Order : name
Parameters :
name
Location : path
Required : Yes
Type : string
Description : Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
HTTP Method : POST
Description : Executes code statelessly.
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Type : string
Description : The name of the operation resource to be cancelled.
Location : path
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$
Path : v1/{+name}:cancel
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/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameter Order : name
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.operations.get
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.
Path : v1/{+name}
Parameter Order : name
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}
Parameters :
name
Description : The name of the operation resource.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Location : path
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.operations.delete
Path : v1/{+name}
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource to be deleted.
Required : Yes
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$
Location : path
Type : string
Parameter Order : name
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`.
HTTP Method : DELETE
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.operations.wait
Path : v1/{+name}:wait
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
Parameter Order : name
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Location : path
timeout
Location : query
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
Format : google-duration
HTTP Method : POST
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.list
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments
Description : Lists SandboxEnvironments in a given reasoning engine.
Path : v1/{+parent}/sandboxEnvironments
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
pageToken
Type : string
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.
Location : query
pageSize
Description : Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.
Location : query
Type : integer
Format : int32
parent
Location : path
Type : string
Required : Yes
Pattern : ^reasoningEngines/[^/]+$
Description : Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
filter
Type : string
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Location : query
HTTP Method : GET
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.delete
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}
HTTP Method : DELETE
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Description : Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Location : path
Required : Yes
Type : string
Description : Deletes the specific SandboxEnvironment.
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.execute
Parameter Order : name
Parameters :
name
Required : Yes
Type : string
Location : path
Description : Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Description : Executes using a sandbox environment.
Path : v1/{+name}:execute
HTTP Method : POST
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.get
Parameter Order : name
HTTP Method : GET
Path : v1/{+name}
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}
Description : Gets details of the specific SandboxEnvironment.
Parameters :
name
Description : Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Location : path
Required : Yes
Type : string
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.create
Description : Creates a SandboxEnvironment in a given reasoning engine.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Description : Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.
Type : string
Pattern : ^reasoningEngines/[^/]+$
Required : Yes
Location : path
HTTP Method : POST
Parameter Order : parent
Path : v1/{+parent}/sandboxEnvironments
Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get
Path : v1/{+name}
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Location : path
Required : Yes
Description : Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
HTTP Method : GET
Parameter Order : name
Description : Gets details of the specific SandboxEnvironment.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Type : string
Description : Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Deletes the specific SandboxEnvironment.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}
HTTP Method : DELETE
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list
Description : Lists SandboxEnvironments in a given reasoning engine.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
pageSize
Format : int32
Description : Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.
Type : integer
Location : query
filter
Location : query
Type : string
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
pageToken
Type : string
Location : query
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Required : Yes
Description : Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments
Path : v1/{+parent}/sandboxEnvironments
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments
Parameter Order : parent
HTTP Method : POST
Parameters :
parent
Location : path
Description : Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Required : Yes
Type : string
Description : Creates a SandboxEnvironment in a given reasoning engine.
Path : v1/{+parent}/sandboxEnvironments
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute
Parameters :
name
Required : Yes
Type : string
Description : Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute
Path : v1/{+name}:execute
Description : Executes using a sandbox environment.
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait
HTTP Method : POST
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait
Parameters :
name
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$
Description : The name of the operation resource to wait on.
timeout
Format : google-duration
Location : query
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
Path : v1/{+name}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameter Order : name
Parameters :
name
Location : path
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$
Required : Yes
Type : string
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`.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel
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`.
Parameters :
name
Description : The name of the operation resource to be cancelled.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$
Required : Yes
Type : string
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
Parameter Order : name
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource.
▼ ▲ aiplatform.projects.locations.reasoningEngines.executeCode
Description : Executes code statelessly.
HTTP Method : POST
Path : v1/{+name}:executeCode
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Type : string
Description : Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:executeCode
▼ ▲ aiplatform.projects.locations.endpoints.openapi.completions
Description : Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
Parameter Order : endpoint
Parameters :
deployedModelId
Description : ID of the DeployedModel that serves the invoke request.
Type : string
Location : query
endpoint
Pattern : ^projects/[^/]+/locations/[^/]+/endpoints/openapi$
Type : string
Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
Location : path
Required : Yes
Path : v1/{+endpoint}/completions
Scopes :
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/completions