2026-04-11
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.snapshot
Path : v1beta1/{+name}:snapshot
Description : Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
Parameters :
name
Description : Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot
▼ ▲ aiplatform.reasoningEngines.memories.retrieveProfiles
Description : Retrieves profiles.
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : parent
Path : v1beta1/{+parent}/memories:retrieveProfiles
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieveProfiles
▼ ▲ aiplatform.reasoningEngines.memories.ingestEvents
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/memories:ingestEvents
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Ingests events for a Memory Bank.
Parameters :
parent
Required : Yes
Location : path
Description : Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Type : string
Parameter Order : parent
HTTP Method : POST
Path : v1beta1/{+parent}/memories:ingestEvents
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.get
Path : v1beta1/{+name}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
Description : Gets details of the specific SandboxEnvironmentSnapshot.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots
Path : v1beta1/{+parent}/sandboxEnvironmentSnapshots
Description : Lists SandboxEnvironmentSnapshots in a given reasoning engine.
HTTP Method : GET
Parameters :
filter
Location : query
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Type : string
pageToken
Location : query
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.
Type : string
parent
Description : Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Type : string
Location : path
Required : Yes
pageSize
Description : Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
Type : integer
Location : query
Format : int32
Parameter Order : parent
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.delete
Path : v1beta1/{+name}
HTTP Method : DELETE
Parameters :
name
Location : path
Required : Yes
Description : Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
Parameter Order : name
Description : Deletes the specific SandboxEnvironmentSnapshot.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}
Path : v1beta1/{+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`.
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
HTTP Method : DELETE
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
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`.
Path : v1beta1/{+name}:cancel
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait
Path : v1beta1/{+name}:wait
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
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
Parameter Order : name
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.list
Parameters :
filter
Description : The standard list filter.
Type : string
Location : query
pageToken
Location : query
Description : The standard list page token.
Type : string
name
Required : Yes
Location : path
Description : The name of the operation's parent resource.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
pageSize
Format : int32
Location : query
Description : The standard list page size.
Type : integer
returnPartialSuccess
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.
Type : boolean
Location : query
Parameter Order : name
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`.
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.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.
HTTP Method : GET
Parameters :
name
Required : Yes
Location : path
Description : The name of the operation resource.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
Path : v1beta1/{+name}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.query
Path : v1beta1/{+name}:query
Description : Queries using a reasoning engine.
HTTP Method : POST
Parameters :
name
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.streamQuery
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery
Path : v1beta1/{+name}:streamQuery
Description : Streams queries using a reasoning engine.
HTTP Method : POST
Parameters :
name
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Location : path
Required : Yes
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks$
Type : string
Parameter Order :
HTTP Method : GET
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.extendedAgentCard
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Parameters :
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Location : path
Required : Yes
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^extendedAgentCard$
Type : string
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order :
HTTP Method : GET
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/extendedAgentCard
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.card
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^card$
Type : string
historyLength
Location : query
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Parameter Order :
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/card
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.message.stream
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:stream
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:stream
Parameters :
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.
Pattern : ^message$
Type : string
Required : Yes
Location : path
Parameter Order :
HTTP Method : POST
Description : Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.message.send
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:send
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:send
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
HTTP Method : POST
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Location : path
Required : Yes
a2aEndpoint
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^message$
Type : string
Location : path
Required : Yes
Parameter Order :
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks
Description : Get request for reasoning engine instance via the A2A get protocol apis.
HTTP Method : GET
Parameters :
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks$
Type : string
Required : Yes
Location : path
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order :
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.extendedAgentCard
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/extendedAgentCard
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Location : path
Required : Yes
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/extendedAgentCard$
Type : string
Parameter Order :
HTTP Method : GET
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.card
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/card
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/card$
Type : string
Required : Yes
Location : path
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order :
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.message.stream
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:stream
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.
Pattern : ^v1/message$
Type : string
Location : path
Required : Yes
Parameter Order :
HTTP Method : POST
Description : Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:stream
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.message.send
HTTP Method : POST
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^v1/message$
Type : string
Location : path
Required : Yes
Parameter Order :
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:send
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:send
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.subscribe
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe
HTTP Method : GET
Parameters :
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.
Pattern : ^v1/tasks/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order :
Description : Stream get request for reasoning engine instance via the A2A stream get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:subscribe
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.cancel
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
HTTP Method : POST
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^v1/tasks/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order :
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:cancel
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Description : Get request for reasoning engine instance via the A2A get protocol apis.
HTTP Method : GET
Parameters :
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks/[^/]+/pushNotificationConfigs$
Type : string
historyLength
Location : query
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Parameter Order :
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.a2aGetReasoningEngine
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Description : Get request for reasoning engine instance via the A2A get protocol apis.
HTTP Method : GET
Parameters :
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks/[^/]+$
Type : string
Required : Yes
Location : path
historyLength
Location : query
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Parameter Order :
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
HTTP Method : GET
Parameters :
a2aEndpoint
Location : path
Required : Yes
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$
Type : string
historyLength
Location : query
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order :
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.subscribe
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.
Pattern : ^tasks/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order :
Description : Stream get request for reasoning engine instance via the A2A stream get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:subscribe
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.cancel
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
HTTP Method : POST
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Location : path
Required : Yes
a2aEndpoint
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^tasks/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order :
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:cancel
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs
Description : Get request for reasoning engine instance via the A2A get protocol apis.
HTTP Method : GET
Parameters :
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Location : path
Required : Yes
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+/pushNotificationConfigs$
Type : string
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order :
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.a2aGetReasoningEngine
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Parameters :
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+$
Type : string
Location : path
Required : Yes
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order :
HTTP Method : GET
▼ ▲ aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order :
HTTP Method : GET
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.delete
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
HTTP Method : DELETE
Description : Deletes the specific SandboxEnvironmentTemplate.
Path : v1beta1/{+name}
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.create
Parameters :
parent
Location : path
Required : Yes
Description : Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.
Pattern : ^reasoningEngines/[^/]+$
Type : string
Parameter Order : parent
HTTP Method : POST
Description : Creates a SandboxEnvironmentTemplate in a given reasoning engine.
Path : v1beta1/{+parent}/sandboxEnvironmentTemplates
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates
Path : v1beta1/{+parent}/sandboxEnvironmentTemplates
Parameters :
parent
Description : Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^reasoningEngines/[^/]+$
Type : string
Required : Yes
Location : path
pageSize
Description : Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
Type : integer
Format : int32
Location : query
filter
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Type : string
Location : query
pageToken
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.
Type : string
Location : query
Parameter Order : parent
HTTP Method : GET
Description : Lists SandboxEnvironmentTemplates in a given reasoning engine.
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.get
Path : v1beta1/{+name}
Description : Gets details of the specific SandboxEnvironmentTemplate.
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.list
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
Location : path
Required : Yes
filter
Location : query
Description : The standard list filter.
Type : string
pageToken
Description : The standard list page token.
Type : string
Location : query
pageSize
Description : The standard list page size.
Type : integer
Location : query
Format : int32
returnPartialSuccess
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.
Type : boolean
Parameter Order : name
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`.
Path : v1beta1/{+name}/operations
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.delete
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
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`.
Parameters :
name
Required : Yes
Location : path
Description : The name of the operation resource to be deleted.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
HTTP Method : DELETE
Path : v1beta1/{+name}
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel
HTTP Method : POST
Parameters :
name
Required : Yes
Location : path
Description : The name of the operation resource to be cancelled.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
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`.
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait
Path : v1beta1/{+name}:wait
HTTP Method : POST
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to wait on.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
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
Parameter Order : name
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.reasoningEngines.sandboxEnvironmentTemplates.operations.get
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource.
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : name
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 : v1beta1/{+name}
▼ ▲ aiplatform.onlineEvaluators.operations.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.
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^onlineEvaluators/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : name
Path : v1beta1/{+name}
Flat Path : v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}
▼ ▲ aiplatform.onlineEvaluators.operations.list
Flat Path : v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Description : The standard list page size.
Type : integer
Location : query
Format : int32
returnPartialSuccess
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.
Type : boolean
filter
Location : query
Description : The standard list filter.
Type : string
pageToken
Description : The standard list page token.
Type : string
Location : query
name
Location : path
Required : Yes
Description : The name of the operation's parent resource.
Pattern : ^onlineEvaluators/[^/]+$
Type : string
Parameter Order : name
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`.
Path : v1beta1/{+name}/operations
▼ ▲ aiplatform.onlineEvaluators.operations.delete
Flat Path : v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^onlineEvaluators/[^/]+/operations/[^/]+$
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`.
Path : v1beta1/{+name}
▼ ▲ aiplatform.onlineEvaluators.operations.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`.
HTTP Method : POST
Parameters :
name
Required : Yes
Location : path
Description : The name of the operation resource to be cancelled.
Pattern : ^onlineEvaluators/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.onlineEvaluators.operations.wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait
Path : v1beta1/{+name}:wait
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^onlineEvaluators/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
timeout
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
Location : query
Format : google-duration
Parameter Order : name
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.onlineEvaluators.operations.list
HTTP Method : GET
Parameters :
filter
Description : The standard list filter.
Type : string
Location : query
pageToken
Location : query
Description : The standard list page token.
Type : string
name
Location : path
Required : Yes
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$
Type : string
pageSize
Format : int32
Location : query
Description : The standard list page size.
Type : integer
returnPartialSuccess
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.
Type : boolean
Parameter Order : name
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations
▼ ▲ aiplatform.projects.locations.onlineEvaluators.operations.delete
Path : v1beta1/{+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`.
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.onlineEvaluators.operations.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel
Path : v1beta1/{+name}:cancel
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
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.projects.locations.onlineEvaluators.operations.wait
Path : v1beta1/{+name}:wait
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.
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
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
Parameter Order : name
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.projects.locations.onlineEvaluators.operations.get
Path : v1beta1/{+name}
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
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
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.get
Parameters :
name
Location : path
Required : Yes
Description : Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
Parameter Order : name
HTTP Method : GET
Description : Gets details of the specific SandboxEnvironmentTemplate.
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates
Path : v1beta1/{+parent}/sandboxEnvironmentTemplates
Description : Lists SandboxEnvironmentTemplates in a given reasoning engine.
Parameters :
parent
Description : Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Required : Yes
Location : path
pageSize
Location : query
Format : int32
Description : Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
Type : integer
filter
Location : query
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Type : string
pageToken
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.
Type : string
Location : query
Parameter Order : parent
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.create
Path : v1beta1/{+parent}/sandboxEnvironmentTemplates
Description : Creates a SandboxEnvironmentTemplate in a given reasoning engine.
HTTP Method : POST
Parameters :
parent
Location : path
Required : Yes
Description : Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
Path : v1beta1/{+name}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
Description : Deletes the specific SandboxEnvironmentTemplate.
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.list
Path : v1beta1/{+name}/operations
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Type : string
filter
Description : The standard list filter.
Type : string
Location : query
pageToken
Description : The standard list page token.
Type : string
Location : query
pageSize
Description : The standard list page size.
Type : integer
Location : query
Format : int32
returnPartialSuccess
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.
Type : boolean
Location : query
Parameter Order : name
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`.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.delete
Path : v1beta1/{+name}
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
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
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel
Path : v1beta1/{+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`.
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.wait
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.
HTTP Method : POST
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
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
Parameter Order : name
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.get
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
HTTP Method : GET
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
Path : v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.list
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
parent
Description : Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Location : path
Required : Yes
pageSize
Format : int32
Location : query
Description : Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
Type : integer
filter
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Type : string
Location : query
pageToken
Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.
Type : string
Location : query
Parameter Order : parent
Description : Lists SandboxEnvironmentSnapshots in a given reasoning engine.
Path : v1beta1/{+parent}/sandboxEnvironmentSnapshots
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.get
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
name
Required : Yes
Location : path
Description : Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
Parameter Order : name
Description : Gets details of the specific SandboxEnvironmentSnapshot.
Path : v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.delete
Description : Deletes the specific SandboxEnvironmentSnapshot.
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : name
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}
Path : v1beta1/{+name}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
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.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.list
Path : v1beta1/{+name}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters :
pageSize
Description : The standard list page size.
Type : integer
Format : int32
Location : query
returnPartialSuccess
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.
Type : boolean
name
Required : Yes
Location : path
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$
Type : string
filter
Location : query
Description : The standard list filter.
Type : string
pageToken
Location : query
Description : The standard list page token.
Type : string
Parameter Order : name
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Required : Yes
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
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`.
Path : v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel
HTTP Method : POST
Parameters :
name
Required : Yes
Location : path
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
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`.
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait
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.
Parameters :
name
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$
Type : string
Location : path
Required : Yes
timeout
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
Location : query
Parameter Order : name
HTTP Method : POST
Path : v1beta1/{+name}:wait
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}
Path : v1beta1/{+name}
Description : Deletes a reasoning engine revision.
Parameters :
name
Description : Required. The name of the ReasoningEngineRuntimeRevision resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtime_revision}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : name
HTTP Method : DELETE
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.streamQuery
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery
Path : v1beta1/{+name}:streamQuery
HTTP Method : POST
Parameters :
name
Required : Yes
Location : path
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order : name
Description : Streams queries using a reasoning engine.
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions
Path : v1beta1/{+parent}/runtimeRevisions
Description : Lists runtime revisions in a reasoning engine.
Parameters :
filter
Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
Type : string
Location : query
pageToken
Description : Optional. The standard list page token.
Type : string
Location : query
parent
Description : Required. The resource name of the ReasoningEngine to list the ReasoningEngineRuntimeRevisions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Location : path
Required : Yes
pageSize
Location : query
Format : int32
Description : Optional. The maximum number of ReasoningEngineRuntimeRevisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Type : integer
Parameter Order : parent
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.query
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query
Path : v1beta1/{+name}:query
Description : Queries using a reasoning engine.
HTTP Method : POST
Parameters :
name
Location : path
Required : Yes
Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.get
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a reasoning engine runtime revision.
Parameters :
name
Description : Required. The name of the ReasoningEngineRuntimeRevision resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtimeRevision}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
HTTP Method : GET
Path : v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.card
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/card
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Parameters :
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^card$
Type : string
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order :
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
historyLength
Location : query
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks$
Type : string
Required : Yes
Location : path
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order :
HTTP Method : GET
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.extendedAgentCard
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
HTTP Method : GET
Parameters :
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^extendedAgentCard$
Type : string
historyLength
Location : query
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order :
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/extendedAgentCard
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks$
Type : string
historyLength
Location : query
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Parameter Order :
HTTP Method : GET
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.extendedAgentCard
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Parameters :
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Location : path
Required : Yes
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/extendedAgentCard$
Type : string
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order :
HTTP Method : GET
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/extendedAgentCard
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.card
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/card
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Parameters :
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/card$
Type : string
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order :
HTTP Method : GET
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.stream
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:stream
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:stream
Description : Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
HTTP Method : POST
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Location : path
Required : Yes
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.
Pattern : ^v1/message$
Type : string
Location : path
Required : Yes
Parameter Order :
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.send
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:send
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Required : Yes
Location : path
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^v1/message$
Type : string
Parameter Order :
HTTP Method : POST
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:send
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.a2aGetReasoningEngine
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order :
HTTP Method : GET
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.subscribe
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.
Pattern : ^v1/tasks/[^/]+$
Type : string
Parameter Order :
Description : Stream get request for reasoning engine instance via the A2A stream get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:subscribe
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.cancel
HTTP Method : POST
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Location : path
Required : Yes
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^v1/tasks/[^/]+$
Type : string
Parameter Order :
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:cancel
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Get request for reasoning engine instance via the A2A get protocol apis.
HTTP Method : GET
Parameters :
a2aEndpoint
Location : path
Required : Yes
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks/[^/]+/pushNotificationConfigs$
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Parameter Order :
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine
HTTP Method : GET
Parameters :
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$
Type : string
Required : Yes
Location : path
historyLength
Location : query
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Parameter Order :
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.stream
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:stream
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:stream
Description : Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.
Pattern : ^message$
Type : string
Parameter Order :
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.send
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:send
HTTP Method : POST
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^message$
Type : string
Required : Yes
Location : path
Parameter Order :
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:send
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.a2aGetReasoningEngine
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
Parameters :
name
Required : Yes
Location : path
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Required : Yes
Location : path
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+$
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
Parameter Order :
HTTP Method : GET
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:cancel
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel
Description : Send post request for reasoning engine instance via the A2A post protocol apis.
HTTP Method : POST
Parameters :
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Required : Yes
Location : path
Description : Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send
Pattern : ^tasks/[^/]+$
Type : string
Parameter Order :
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
HTTP Method : GET
Parameters :
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
historyLength
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
Location : query
a2aEndpoint
Location : path
Required : Yes
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+/pushNotificationConfigs$
Type : string
Parameter Order :
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.subscribe
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:subscribe
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Required : Yes
Description : Required. The full resource path of the reasoning engine, captured from the URL.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
a2aEndpoint
Location : path
Required : Yes
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.
Pattern : ^tasks/[^/]+$
Type : string
Parameter Order :
HTTP Method : GET
Description : Stream get request for reasoning engine instance via the A2A stream get protocol apis.
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe
▼ ▲ aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameters :
name
Description : Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$
Type : string
Required : Yes
Location : path
historyLength
Location : query
Description : Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
Type : string
a2aEndpoint
Description : Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`
Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order :
Description : Get request for reasoning engine instance via the A2A get protocol apis.
Path : v1beta1/{+name}/a2a/{+a2aEndpoint}
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.snapshot
Parameters :
name
Location : path
Required : Yes
Description : Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$
Type : string
Parameter Order : name
HTTP Method : POST
Description : Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
Path : v1beta1/{+name}:snapshot
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot
▼ ▲ aiplatform.projects.locations.reasoningEngines.memories.retrieveProfiles
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieveProfiles
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieves profiles.
Parameters :
parent
Description : Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : parent
HTTP Method : POST
Path : v1beta1/{+parent}/memories:retrieveProfiles
▼ ▲ aiplatform.projects.locations.reasoningEngines.memories.ingestEvents
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:ingestEvents
Path : v1beta1/{+parent}/memories:ingestEvents
HTTP Method : POST
Parameters :
parent
Description : Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : parent
Description : Ingests events for a Memory Bank.