Vertex AI API (aiplatform:v1beta1)

2026-03-14

10 new methods | 4 updated methods

Additions

    Methods
  • aiplatform.reasoningEngines.runtimeRevisions.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.

      Path : v1beta1/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$

          Required : Yes

          Description : The name of the operation resource.

          Type : string

          Location : path

  • aiplatform.reasoningEngines.runtimeRevisions.operations.list

      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

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations

      HTTP Method : GET

      Parameters :

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          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.

          Location : query

          Type : boolean

        name

          Location : path

          Type : string

          Description : The name of the operation's parent resource.

          Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$

          Required : Yes

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

  • aiplatform.reasoningEngines.runtimeRevisions.operations.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}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}

      HTTP Method : DELETE

      Parameters :

        name

          Location : path

          Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$

          Required : Yes

          Description : The name of the operation resource to be deleted.

          Type : string

  • aiplatform.reasoningEngines.runtimeRevisions.operations.cancel

      Parameters :

        name

          Location : path

          Description : The name of the operation resource to be cancelled.

          Type : string

          Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$

          Required : Yes

      Parameter Order : name

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel

      HTTP Method : POST

      Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

      Path : v1beta1/{+name}:cancel

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • aiplatform.reasoningEngines.runtimeRevisions.operations.wait

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

      Path : v1beta1/{+name}:wait

      Parameter Order : name

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait

      HTTP Method : POST

      Parameters :

        name

          Pattern : ^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$

          Required : Yes

          Description : The name of the operation resource to wait on.

          Type : string

          Location : path

        timeout

          Location : query

          Type : string

          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.

  • aiplatform.projects.locations.reasoningEngines.runtimeRevisions.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`.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$

          Required : Yes

          Type : string

          Description : The name of the operation resource to be deleted.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}

      HTTP Method : DELETE

      Parameter Order : name

  • aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.cancel

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameter Order : name

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$

          Required : Yes

          Type : string

          Description : The name of the operation resource to be cancelled.

      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`.

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • aiplatform.projects.locations.reasoningEngines.runtimeRevisions.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.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$

          Required : Yes

          Type : string

          Description : The name of the operation resource to wait on.

        timeout

          Location : query

          Type : string

          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.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait

      HTTP Method : POST

      Parameter Order : name

  • aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.get

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$

          Required : Yes

          Type : string

          Description : The name of the operation resource.

          Location : path

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}

      HTTP Method : GET

      Parameter Order : name

      Path : v1beta1/{+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.

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.list

      Parameter Order : name

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations

      HTTP Method : GET

      Parameters :

        filter

          Location : query

          Type : string

          Description : The standard list filter.

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          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.

          Location : query

          Type : boolean

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$

          Required : Yes

          Type : string

          Description : The name of the operation's parent resource.

          Location : path

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

      Scopes : https://www.googleapis.com/auth/cloud-platform

      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

Updates

    Methods
  • aiplatform.reasoningEngines.sessions.create

      Parameters :

        sessionId

          Location : query

          Type : string

          Description : Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.

  • aiplatform.reasoningEngines.memories.create

      Parameters :

        memoryId

          Location : query

          Type : string

          Description : Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.

  • aiplatform.projects.locations.reasoningEngines.memories.create

      Parameters :

        memoryId

          Description : Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.

          Location : query

          Type : string

  • aiplatform.projects.locations.reasoningEngines.sessions.create

      Parameters :

        sessionId

          Location : query

          Type : string

          Description : Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.