Agent Platform API (aiplatform:v1)

2026-07-30

11 new methods

Additions

    Methods
  • aiplatform.servingProfiles.operations.delete

      Parameter Order : name

      HTTP Method : DELETE

      Path : v1/{+name}

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

      Flat Path : v1/servingProfiles/{servingProfilesId}/operations/{operationsId}

      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 : ^servingProfiles/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

  • aiplatform.servingProfiles.operations.list

      Parameters :

        name

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

          Pattern : ^servingProfiles/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Location : query

          Description : The standard list filter.

          Type : string

        pageToken

          Location : query

          Description : The standard list page token.

          Type : string

        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

        pageSize

          Location : query

          Format : int32

          Description : The standard list page size.

          Type : integer

      Flat Path : v1/servingProfiles/{servingProfilesId}/operations

      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

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

      HTTP Method : GET

      Parameter Order : name

  • aiplatform.servingProfiles.operations.get

      HTTP Method : GET

      Parameter Order : name

      Path : v1/{+name}

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

      Flat Path : v1/servingProfiles/{servingProfilesId}/operations/{operationsId}

      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.

      Parameters :

        name

          Required : Yes

          Type : string

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

          Location : path

          Description : The name of the operation resource.

  • aiplatform.servingProfiles.operations.cancel

      Flat Path : v1/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel

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

      Parameters :

        name

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

          Location : path

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

          Required : Yes

          Type : string

      HTTP Method : POST

      Parameter Order : name

      Path : v1/{+name}:cancel

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

  • aiplatform.servingProfiles.operations.wait

      Flat Path : v1/servingProfiles/{servingProfilesId}/operations/{operationsId}: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 :

        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

        name

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

          Location : path

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

          Required : Yes

          Type : string

      HTTP Method : POST

      Parameter Order : name

      Path : v1/{+name}:wait

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

  • aiplatform.projects.locations.servingProfiles.operations.list

      Parameters :

        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

        pageSize

          Location : query

          Format : int32

          Description : The standard list page size.

          Type : integer

        name

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

          Location : path

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

          Required : Yes

          Type : string

        filter

          Location : query

          Description : The standard list filter.

          Type : string

        pageToken

          Location : query

          Description : The standard list page token.

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations

      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

      Path : v1/{+name}/operations

      HTTP Method : GET

      Parameter Order : name

  • aiplatform.projects.locations.servingProfiles.operations.delete

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}

      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

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

          Location : path

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

          Required : Yes

          Type : string

      HTTP Method : DELETE

      Parameter Order : name

      Path : v1/{+name}

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

  • aiplatform.projects.locations.servingProfiles.operations.wait

      Parameter Order : name

      HTTP Method : POST

      Path : v1/{+name}:wait

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}: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

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

          Location : path

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

          Required : Yes

          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

  • aiplatform.projects.locations.servingProfiles.operations.get

      Parameters :

        name

          Required : Yes

          Type : string

          Description : The name of the operation resource.

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

          Location : path

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}

      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

      Path : v1/{+name}

      Parameter Order : name

      HTTP Method : GET

  • aiplatform.projects.locations.servingProfiles.operations.cancel

      HTTP Method : POST

      Parameter Order : name

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

      Path : v1/{+name}:cancel

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel

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

      Parameters :

        name

          Required : Yes

          Type : string

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

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

          Location : path

  • aiplatform.projects.locations.publishers.v1.responses.compact

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/compact

      Description : Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

      Parameters :

        endpoint

          Required : Yes

          Type : string

          Description : Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`

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

          Location : path

        deployedModelId

          Description : ID of the DeployedModel that serves the invoke request.

          Type : string

          Location : query

      Parameter Order : endpoint

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Path : v1/{+endpoint}/v1/responses/compact