Agent Platform API (aiplatform:v1beta1)

2026-05-02

15 new methods

Additions

    Methods
  • aiplatform.vertexExpress.signUp

      HTTP Method : POST

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

      Path : v1beta1/vertexExpress:signUp

      Description : Signs up the user for Vertex AI Express Mode. If the user is already signed up, the existing ExpressProject will be returned.

      Flat Path : v1beta1/vertexExpress:signUp

  • aiplatform.vertexExpress.retrieveExpressProject

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

      HTTP Method : GET

      Parameters :

        getDefaultApiKey

          Type : boolean

          Description : Optional. Whether to return the default API key string in the response.

          Location : query

      Path : v1beta1/vertexExpress:retrieveExpressProject

      Description : Retrieves the project for Vertex AI Express Mode.

      Flat Path : v1beta1/vertexExpress:retrieveExpressProject

  • aiplatform.vertexExpress.Eligibility.check

      HTTP Method : GET

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

      Path : v1beta1/vertexExpress/Eligibility:check

      Description : Checks whether the user is eligible to sign up for Vertex AI Express Mode.

      Flat Path : v1beta1/vertexExpress/Eligibility:check

  • aiplatform.projects.locations.reasoningEngines.asyncQuery

      Parameter Order : name

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

      HTTP Method : POST

      Parameters :

        name

          Type : string

          Required : Yes

          Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

          Location : path

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

      Path : v1beta1/{+name}:asyncQuery

      Description : Async query using a reasoning engine.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:asyncQuery

  • aiplatform.projects.locations.skills.operations.list

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations

      HTTP Method : GET

      Parameters :

        filter

          Description : The standard list filter.

          Type : string

          Location : query

        name

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/skills/[^/]+$

          Location : path

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

          Required : Yes

        returnPartialSuccess

          Type : boolean

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Location : query

        pageSize

          Location : query

          Type : integer

          Format : int32

          Description : The standard list page size.

        pageToken

          Description : The standard list page token.

          Type : string

          Location : query

      Parameter Order : name

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

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

  • aiplatform.projects.locations.skills.operations.get

      Parameter Order : name

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

      HTTP Method : GET

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$

          Required : Yes

          Description : The name of the operation resource.

          Type : string

      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.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}

  • aiplatform.projects.locations.skills.operations.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`.

      Parameter Order : name

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

      HTTP Method : POST

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$

          Location : path

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

          Required : Yes

          Type : string

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:cancel

  • aiplatform.projects.locations.skills.operations.wait

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}:wait

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$

          Required : Yes

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

          Type : string

        timeout

          Location : query

          Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

          Type : string

          Format : google-duration

      HTTP Method : POST

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

      Parameter Order : name

      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.

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

      Parameter Order : name

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

      HTTP Method : DELETE

      Parameters :

        name

          Type : string

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

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/skills/[^/]+/operations/[^/]+$

          Location : path

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/skills/{skillsId}/operations/{operationsId}

  • aiplatform.skills.operations.get

      Parameters :

        name

          Type : string

          Description : The name of the operation resource.

          Required : Yes

          Pattern : ^skills/[^/]+/operations/[^/]+$

          Location : path

      HTTP Method : GET

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

      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.

      Flat Path : v1beta1/skills/{skillsId}/operations/{operationsId}

  • aiplatform.skills.operations.cancel

      Flat Path : v1beta1/skills/{skillsId}/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`.

      Parameter Order : name

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

      HTTP Method : POST

      Parameters :

        name

          Type : string

          Pattern : ^skills/[^/]+/operations/[^/]+$

          Location : path

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

          Required : Yes

  • aiplatform.skills.operations.list

      Flat Path : v1beta1/skills/{skillsId}/operations

      Parameters :

        name

          Pattern : ^skills/[^/]+$

          Location : path

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

          Required : Yes

          Type : string

        returnPartialSuccess

          Type : boolean

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Location : query

        pageSize

          Location : query

          Type : integer

          Format : int32

          Description : The standard list page size.

        pageToken

          Type : string

          Description : The standard list page token.

          Location : query

        filter

          Description : The standard list filter.

          Type : string

          Location : query

      HTTP Method : GET

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

      Parameter Order : name

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

  • aiplatform.skills.operations.delete

      Flat Path : v1beta1/skills/{skillsId}/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`.

      Parameter Order : name

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

      HTTP Method : DELETE

      Parameters :

        name

          Required : Yes

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

          Location : path

          Pattern : ^skills/[^/]+/operations/[^/]+$

          Type : string

  • aiplatform.skills.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.

      HTTP Method : POST

      Parameters :

        name

          Type : string

          Location : path

          Pattern : ^skills/[^/]+/operations/[^/]+$

          Required : Yes

          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.

      Parameter Order : name

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

      Flat Path : v1beta1/skills/{skillsId}/operations/{operationsId}:wait

  • aiplatform.reasoningEngines.asyncQuery

      Path : v1beta1/{+name}:asyncQuery

      Description : Async query using a reasoning engine.

      Parameters :

        name

          Type : string

          Required : Yes

          Description : Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

          Location : path

          Pattern : ^reasoningEngines/[^/]+$

      HTTP Method : POST

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

      Parameter Order : name

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}:asyncQuery