Agent Platform API (aiplatform:v1beta1)

2026-10-29

6 new methods | 1 updated method | 8 removed methods

Additions

    Methods
  • ▼ ▲ aiplatform.projects.locations.publishers.models.batchEmbedContents

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:batchEmbedContents

      Parameter Order : model

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Path : v1beta1/{+model}:batchEmbedContents

      Parameters :

        model

          Description : Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

          Required : Yes

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

          Type : string

          Location : path

      HTTP Method : POST

      Description : Generates embeddings directly from multiple contents.

  • ▼ ▲ aiplatform.projects.locations.publishers.files.upload

      Parameters :

        parent

          Location : path

          Type : string

          Description : Required. The location to create the file under. Format: `projects/{project}/locations/{location}`

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

          Required : Yes

        publishersId

          Type : string

          Location : path

          Required : Yes

      Supportsmediaupload : Yes

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

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files

      Path : v1beta1/{+parent}/publishers/{publishersId}/files

      HTTP Method : POST

      Parameter Order :

    • parent
    • publishersId
    • Mediaupload :

        Protocols :

          Simple :

            Multipart : Yes

            Path : /upload/v1beta1/{+parent}/publishers/{publishersId}/files

        Maxsize : 524288000

        Accept : */*

      Description : Uploads a file that can be referenced by ID from subsequent Claude model requests.

  • ▼ ▲ aiplatform.projects.locations.publishers.files.get

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files/{filesId}

      Parameter Order : name

      Description : Gets the metadata for the given file.

      Parameters :

        name

          Required : Yes

          Description : Required. The name of the file to get. Format: `projects/{project}/locations/{location}/publishers/{publisher}/files/{file}`

          Location : path

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

          Type : string

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

      Path : v1beta1/{+name}

      HTTP Method : GET

  • ▼ ▲ aiplatform.projects.locations.publishers.files.list

      Description : Lists the files owned by the requesting project and location. Supports two mutually exclusive modes: paginated listing via an opaque `page` cursor, or batch fetch by `ids`. See `ListFilesRequest`.

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

      Path : v1beta1/{+parent}/publishers/{publishersId}/files

      HTTP Method : GET

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files

      Parameter Order :

    • parent
    • publishersId
    • Parameters :

        limit

          Location : query

          Type : integer

          Format : int32

          Description : Optional. The number of files to return per page. Defaults to 20 if unset, maximum 1000. Mutually exclusive with `ids`.

        ids

          Type : string

          Location : query

          Repeated : Yes

          Description : Optional. Batch fetch: return only these files, up to 100 IDs after de-duplication. Mutually exclusive with both `page` and `limit`. Serialised as a repeated `ids` query parameter, one occurrence per ID.

        publishersId

          Type : string

          Location : path

          Required : Yes

        page

          Description : Optional. Opaque pagination cursor. Pass the previous response's `next_page` to fetch the next page. Mutually exclusive with `ids`.

          Type : string

          Location : query

        parent

          Description : Required. The location to list files under. Format: `projects/{project}/locations/{location}`

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

          Location : path

          Required : Yes

          Type : string

  • ▼ ▲ aiplatform.projects.locations.publishers.files.delete

      Description : Deletes the given file. Returns the deleted file's ID rather than an empty body. See `DeleteFileResponse`.

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

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files/{filesId}

      Parameters :

        name

          Location : path

          Description : Required. The name of the file to delete. Format: `projects/{project}/locations/{location}/publishers/{publisher}/files/{file}`

          Type : string

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

          Required : Yes

      HTTP Method : DELETE

      Parameter Order : name

  • ▼ ▲ aiplatform.projects.locations.publishers.files.download

      Usemediadownloadservice : Yes

      Parameter Order : name

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files/{filesId}/content

      Supportsmediadownload : Yes

      Path : v1beta1/{+name}/content

      Parameters :

        name

          Description : Required. The name of the file to download. Format: `projects/{project}/locations/{location}/publishers/{publisher}/files/{file}`

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

          Location : path

          Required : Yes

          Type : string

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

      Description : Downloads the contents of the given file. Only files marked `downloadable` can be retrieved this way; user-uploaded files are not downloadable.

      HTTP Method : GET

Updates

    Methods
  • ▼ ▲ aiplatform.projects.locations.agents.create

      Parameters :

        idpNonce

          Location : query

          Description : Optional. Optional. One-time cryptographic nonce issued by the trusted IdP provisioning iframe for session and device non-repudiation.

          Type : string

Deletions

    Methods
  • ▼ ▲ aiplatform.evaluationTasks.operations.get

      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.

      Parameters :

        name

          Required : Yes

          Description : The name of the operation resource.

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

          Type : string

          Location : path

      Flat Path : v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform
    • Parameter Order : name

      Path : v1beta1/{+name}

  • ▼ ▲ aiplatform.evaluationTasks.operations.delete

      HTTP Method : DELETE

      Parameters :

        name

          Location : path

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

          Type : string

          Required : Yes

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

      Flat Path : v1beta1/evaluationTasks/{evaluationTasksId}/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

  • ▼ ▲ aiplatform.evaluationTasks.operations.list

      HTTP Method : GET

      Flat Path : v1beta1/evaluationTasks/{evaluationTasksId}/operations

      Parameters :

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        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

        name

          Location : path

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

          Pattern : ^evaluationTasks/[^/]+$

          Required : Yes

          Type : string

        filter

          Type : string

          Location : query

          Description : The standard list filter.

        pageToken

          Location : query

          Description : The standard list page token.

          Type : string

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

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform
  • ▼ ▲ aiplatform.evaluationTasks.operations.wait

      Parameters :

        timeout

          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

          Location : query

        name

          Required : Yes

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

          Type : string

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

          Location : path

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • 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/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait

  • ▼ ▲ aiplatform.projects.locations.evaluationTasks.operations.get

      Parameters :

        name

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

          Location : path

          Type : string

          Description : The name of the operation resource.

          Required : Yes

      HTTP Method : GET

      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.

      Path : v1beta1/{+name}

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}

  • ▼ ▲ aiplatform.projects.locations.evaluationTasks.operations.list

      Path : v1beta1/{+name}/operations

      Parameters :

        pageSize

          Location : query

          Format : int32

          Description : The standard list page size.

          Type : integer

        name

          Type : string

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

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

          Required : Yes

          Location : path

        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

        pageToken

          Type : string

          Description : The standard list page token.

          Location : query

        filter

          Location : query

          Description : The standard list filter.

          Type : string

      Parameter Order : name

      HTTP Method : GET

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • 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`.

  • ▼ ▲ aiplatform.projects.locations.evaluationTasks.operations.wait

      Parameters :

        name

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

          Location : path

          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

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/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.

      HTTP Method : POST

      Path : v1beta1/{+name}:wait

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/aiplatform
    • https://www.googleapis.com/auth/cloud-platform
  • ▼ ▲ aiplatform.projects.locations.evaluationTasks.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}

      HTTP Method : DELETE

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}

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

      Parameters :

        name

          Type : string

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

          Location : path

          Required : Yes

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

      Parameter Order : name