Agent Platform API (aiplatform:v1)

2026-07-14

10 new methods

Additions

    Methods
  • aiplatform.projects.locations.memoryBanks.memories.patch

      Description : Update a Memory.

      HTTP Method : PATCH

      Parameters :

        name

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

          Type : string

          Description : Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

          Required : Yes

          Location : path

        updateMask

          Location : query

          Type : string

          Format : google-fieldmask

          Description : Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`

      Parameter Order : name

      Path : v1/{+name}

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}

  • aiplatform.projects.locations.memoryBanks.memories.list

      HTTP Method : GET

      Parameters :

        filter

          Location : query

          Type : string

          Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`)

        orderBy

          Location : query

          Type : string

          Description : Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`

        pageSize

          Location : query

          Type : integer

          Format : int32

          Description : Optional. The standard list page size.

        pageToken

          Location : query

          Type : string

          Description : Optional. The standard list page token.

        parent

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

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

          Type : string

          Required : Yes

          Location : path

      Parameter Order : parent

      Description : List Memories.

      Path : v1/{+parent}/memories

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories

  • aiplatform.projects.locations.memoryBanks.memories.delete

      Description : Delete a Memory.

      HTTP Method : DELETE

      Parameters :

        name

          Location : path

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

          Type : string

          Description : Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

          Required : Yes

      Parameter Order : name

      Path : v1/{+name}

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}

  • aiplatform.projects.locations.memoryBanks.memories.retrieve

      Description : Retrieve memories.

      HTTP Method : POST

      Parameters :

        parent

          Location : path

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

          Type : string

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

          Required : Yes

      Parameter Order : parent

      Path : v1/{+parent}/memories:retrieve

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieve

  • aiplatform.projects.locations.memoryBanks.memories.purge

      Path : v1/{+parent}/memories:purge

      HTTP Method : POST

      Parameters :

        parent

          Location : path

          Required : Yes

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

          Type : string

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

      Parameter Order : parent

      Description : Purge memories.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:purge

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

  • aiplatform.projects.locations.memoryBanks.memories.rollback

      Path : v1/{+name}:rollback

      HTTP Method : POST

      Parameters :

        name

          Location : path

          Required : Yes

          Description : Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

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

          Type : string

      Parameter Order : name

      Description : Rollback Memory to a specific revision.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}:rollback

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

  • aiplatform.projects.locations.memoryBanks.memories.create

      HTTP Method : POST

      Parameters :

        parent

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

          Type : string

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

          Required : Yes

          Location : path

        memoryId

          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.

          Location : query

      Parameter Order : parent

      Description : Create a Memory.

      Path : v1/{+parent}/memories

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories

  • aiplatform.projects.locations.memoryBanks.memories.generate

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:generate

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

      Path : v1/{+parent}/memories:generate

      HTTP Method : POST

      Parameters :

        parent

          Location : path

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

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

          Type : string

          Required : Yes

      Parameter Order : parent

      Description : Generate memories.

  • aiplatform.projects.locations.memoryBanks.memories.revisions.get

      Description : Get a Memory Revision.

      HTTP Method : GET

      Parameters :

        name

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/revisions/[^/]+$

          Type : string

          Description : Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`

          Location : path

      Parameter Order : name

      Path : v1/{+name}

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions/{revisionsId}

  • aiplatform.projects.locations.memoryBanks.memories.revisions.list

      Description : List Memory Revisions for a Memory.

      HTTP Method : GET

      Parameters :

        pageSize

          Description : Optional. The standard list page size.

          Type : integer

          Format : int32

          Location : query

        pageToken

          Type : string

          Description : Optional. The standard list page token.

          Location : query

        filter

          Type : string

          Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`

          Location : query

        parent

          Description : Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`

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

          Type : string

          Required : Yes

          Location : path

      Parameter Order : parent

      Path : v1/{+parent}/revisions

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions