Agent Platform API (aiplatform:v1)

2026-05-02

12 new methods

Additions

    Methods
  • aiplatform.projects.locations.skills.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 : v1/{+name}

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

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

      Parameters :

        name

          Required : Yes

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

          Type : string

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

          Location : path

      HTTP Method : DELETE

      Parameter Order : name

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

      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 : v1/{+name}/operations

      Parameter Order : name

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

      HTTP Method : GET

      Parameters :

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

        name

          Required : Yes

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

          Type : string

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

          Location : path

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        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

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

      HTTP Method : GET

      Parameters :

        name

          Location : path

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

          Description : The name of the operation resource.

          Type : string

          Required : Yes

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

      Parameter Order : name

      Path : v1/{+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.skills.operations.cancel

      Parameter Order : name

      HTTP Method : POST

      Parameters :

        name

          Location : path

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

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

          Type : string

          Required : Yes

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

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

      Path : v1/{+name}:cancel

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

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

      HTTP Method : POST

      Parameters :

        name

          Required : Yes

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

          Type : string

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

          Location : path

        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.

          Location : query

          Type : string

          Format : google-duration

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

      Parameter Order : name

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

  • aiplatform.projects.locations.reasoningEngines.asyncQuery

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

      Description : Async query using a reasoning engine.

      Path : v1/{+name}:asyncQuery

      Parameter Order : name

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

      Parameters :

        name

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

          Type : string

          Required : Yes

          Location : path

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

      HTTP Method : POST

  • aiplatform.reasoningEngines.asyncQuery

      Parameter Order : name

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

      Parameters :

        name

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

          Type : string

          Required : Yes

          Location : path

          Pattern : ^reasoningEngines/[^/]+$

      HTTP Method : POST

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

      Description : Async query using a reasoning engine.

      Path : v1/{+name}:asyncQuery

  • aiplatform.skills.operations.get

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

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

      Parameter Order : name

      Parameters :

        name

          Required : Yes

          Description : The name of the operation resource.

          Type : string

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

          Location : path

      HTTP Method : GET

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

  • aiplatform.skills.operations.cancel

      Flat Path : v1/skills/{skillsId}/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameters :

        name

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

          Location : path

          Required : Yes

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

          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 : v1/{+name}:cancel

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

  • aiplatform.skills.operations.wait

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

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

      Parameter Order : name

      Parameters :

        name

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

          Type : string

          Required : Yes

          Location : path

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

        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.

          Location : query

          Type : string

          Format : google-duration

      HTTP Method : POST

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

  • aiplatform.skills.operations.delete

      HTTP Method : DELETE

      Parameters :

        name

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

          Type : string

          Required : Yes

          Location : path

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

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

      Parameter Order : name

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

  • aiplatform.skills.operations.list

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

      Path : v1/{+name}/operations

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

      Parameter Order : name

      Parameters :

        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

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        name

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

          Type : string

          Required : Yes

          Location : path

          Pattern : ^skills/[^/]+$

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

      HTTP Method : GET

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