Vertex AI API (aiplatform:v1)

2025-12-10

38 new methods

Additions

    Methods
  • aiplatform.projects.locations.reasoningEngines.memories.revisions.get

      Path : v1/{+name}

      Description : Get a Memory Revision.

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

      Parameters :

        name

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

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

          Required : Yes

          Type : string

          Location : path

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}

      Parameter Order : name

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

      Parameter Order : parent

      Description : List Memory Revisions for a Memory.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions

      HTTP Method : GET

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

      Parameters :

        pageSize

          Location : query

          Description : Optional. The standard list page size.

          Format : int32

          Type : integer

        filter

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

          Type : string

          Location : query

        parent

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

          Location : path

          Type : string

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

          Required : Yes

        pageToken

          Type : string

          Location : query

          Description : Optional. The standard list page token.

      Path : v1/{+parent}/revisions

  • aiplatform.projects.locations.reasoningEngines.memories.operations.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Location : path

          Description : The name of the operation resource.

          Required : Yes

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

          Type : string

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

      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

  • aiplatform.projects.locations.reasoningEngines.memories.operations.delete

      HTTP Method : 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`.

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

      Path : v1/{+name}

      Parameters :

        name

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

          Required : Yes

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

          Location : path

          Type : string

      Parameter Order : name

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}

  • aiplatform.projects.locations.reasoningEngines.memories.operations.list

      Parameter Order : name

      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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations

      Parameters :

        pageToken

          Description : The standard list page token.

          Type : string

          Location : query

        returnPartialSuccess

          Type : boolean

          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.

        filter

          Location : query

          Type : string

          Description : The standard list filter.

        name

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

          Type : string

          Location : path

          Required : Yes

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

        pageSize

          Location : query

          Type : integer

          Description : The standard list page size.

          Format : int32

      HTTP Method : GET

  • aiplatform.projects.locations.reasoningEngines.memories.operations.cancel

      Parameters :

        name

          Required : Yes

          Location : path

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

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

          Type : string

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/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`.

      Path : v1/{+name}:cancel

      Parameter Order : name

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

  • aiplatform.projects.locations.reasoningEngines.memories.operations.wait

      Parameter Order : name

      HTTP Method : POST

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

      Parameters :

        timeout

          Type : string

          Format : google-duration

          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.

        name

          Required : Yes

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

          Location : path

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

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait

  • aiplatform.projects.locations.reasoningEngines.memories.create

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

      Path : v1/{+parent}/memories

      HTTP Method : POST

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

      Parameters :

        parent

          Required : Yes

          Location : path

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

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

          Type : string

      Parameter Order : parent

      Description : Create a Memory.

  • aiplatform.projects.locations.reasoningEngines.memories.generate

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

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

      Parameter Order : parent

      HTTP Method : POST

      Parameters :

        parent

          Location : path

          Type : string

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

          Required : Yes

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

      Description : Generate memories.

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

  • aiplatform.projects.locations.reasoningEngines.memories.list

      Path : v1/{+parent}/memories

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

      HTTP Method : GET

      Parameters :

        parent

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

          Required : Yes

          Type : string

          Location : path

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

        filter

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

          Location : query

          Type : string

        pageToken

          Type : string

          Location : query

          Description : Optional. The standard list page token.

        pageSize

          Description : Optional. The standard list page size.

          Location : query

          Type : integer

          Format : int32

        orderBy

          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`

          Location : query

          Type : string

      Parameter Order : parent

      Description : List Memories.

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

  • aiplatform.projects.locations.reasoningEngines.memories.delete

      Path : v1/{+name}

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

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

      Parameters :

        name

          Required : Yes

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

          Type : string

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

          Location : path

      Parameter Order : name

      Description : Delete a Memory.

      HTTP Method : DELETE

  • aiplatform.projects.locations.reasoningEngines.memories.retrieve

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

      Parameters :

        parent

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

          Type : string

          Required : Yes

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

          Location : path

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

      Parameter Order : parent

      HTTP Method : POST

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

      Description : Retrieve memories.

  • aiplatform.projects.locations.reasoningEngines.memories.rollback

      Path : v1/{+name}:rollback

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback

      Parameter Order : name

      Parameters :

        name

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

          Type : string

          Required : Yes

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

          Location : path

      HTTP Method : POST

      Description : Rollback Memory to a specific revision.

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

  • aiplatform.projects.locations.reasoningEngines.memories.patch

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

      Parameter Order : name

      Path : v1/{+name}

      Description : Update a Memory.

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

      Parameters :

        updateMask

          Location : query

          Description : Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`

          Format : google-fieldmask

          Type : string

        name

          Required : Yes

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

          Type : string

          Location : path

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

      HTTP Method : PATCH

  • aiplatform.projects.locations.reasoningEngines.memories.get

      Description : Get a Memory.

      Path : v1/{+name}

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

      Parameter Order : name

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

      Parameters :

        name

          Location : path

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

          Required : Yes

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

          Type : string

      HTTP Method : GET

  • aiplatform.projects.locations.reasoningEngines.memories.purge

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

      Parameters :

        parent

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

          Type : string

          Required : Yes

          Location : path

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

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

      Description : Purge memories.

      HTTP Method : POST

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

      Parameter Order : parent

  • aiplatform.projects.locations.reasoningEngines.sessions.patch

      Path : v1/{+name}

      Description : Updates the specific Session.

      Parameter Order : name

      HTTP Method : PATCH

      Parameters :

        name

          Required : Yes

          Description : Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.

          Type : string

          Location : path

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

        updateMask

          Format : google-fieldmask

          Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

          Type : string

          Location : query

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

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

  • aiplatform.projects.locations.reasoningEngines.sessions.delete

      Path : v1/{+name}

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

      HTTP Method : DELETE

      Parameters :

        name

          Required : Yes

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

          Type : string

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

          Location : path

      Parameter Order : name

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

      Description : Deletes details of the specific Session.

  • aiplatform.projects.locations.reasoningEngines.sessions.get

      Path : v1/{+name}

      HTTP Method : GET

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

      Parameters :

        name

          Type : string

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

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

          Location : path

          Required : Yes

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

      Description : Gets details of the specific Session.

      Parameter Order : name

  • aiplatform.projects.locations.reasoningEngines.sessions.appendEvent

      Path : v1/{+name}:appendEvent

      Parameter Order : name

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent

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

      Description : Appends an event to a given session.

      Parameters :

        name

          Description : Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

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

          Required : Yes

          Type : string

          Location : path

  • aiplatform.projects.locations.reasoningEngines.sessions.list

      Path : v1/{+parent}/sessions

      Parameters :

        filter

          Description : Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`.

          Location : query

          Type : string

        pageToken

          Type : string

          Location : query

          Description : Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.

        pageSize

          Type : integer

          Location : query

          Description : Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.

          Format : int32

        orderBy

          Type : string

          Location : query

          Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.

        parent

          Location : path

          Type : string

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

          Required : Yes

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

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

      Parameter Order : parent

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

      Description : Lists Sessions in a given reasoning engine.

      HTTP Method : GET

  • aiplatform.projects.locations.reasoningEngines.sessions.create

      Description : Creates a new Session.

      Parameter Order : parent

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

      Parameters :

        parent

          Required : Yes

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

          Type : string

          Location : path

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

      HTTP Method : POST

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

      Path : v1/{+parent}/sessions

  • aiplatform.projects.locations.reasoningEngines.sessions.operations.list

      HTTP Method : GET

      Path : v1/{+name}/operations

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations

      Parameters :

        returnPartialSuccess

          Type : boolean

          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.

        pageToken

          Type : string

          Location : query

          Description : The standard list page token.

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        name

          Required : Yes

          Type : string

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

          Location : path

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

        filter

          Type : string

          Location : query

          Description : The standard list filter.

      Parameter Order : name

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

  • aiplatform.projects.locations.reasoningEngines.sessions.operations.delete

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

      Parameters :

        name

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

          Required : Yes

          Type : string

          Location : path

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}

      HTTP Method : DELETE

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

  • aiplatform.projects.locations.reasoningEngines.sessions.operations.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

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

      Parameters :

        timeout

          Type : string

          Format : google-duration

          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.

        name

          Type : string

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

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

          Location : path

          Required : Yes

      Path : v1/{+name}:wait

      Parameter Order : name

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait

  • aiplatform.projects.locations.reasoningEngines.sessions.operations.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.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}

      Parameter Order : name

      HTTP Method : GET

      Path : v1/{+name}

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

      Parameters :

        name

          Description : The name of the operation resource.

          Required : Yes

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

          Type : string

          Location : path

  • aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel

      Path : v1/{+name}:cancel

      Parameters :

        name

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

          Required : Yes

          Location : path

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

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel

      HTTP Method : POST

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

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

      Parameter Order : name

  • aiplatform.projects.locations.reasoningEngines.sessions.events.list

      Parameter Order : parent

      Description : Lists Events in a given session.

      Parameters :

        parent

          Type : string

          Description : Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`

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

          Location : path

          Required : Yes

        pageToken

          Type : string

          Location : query

          Description : Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.

        filter

          Type : string

          Location : query

          Description : Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).

        pageSize

          Type : integer

          Format : int32

          Location : query

          Description : Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.

        orderBy

          Location : query

          Type : string

          Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.

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

      Path : v1/{+parent}/events

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events

  • aiplatform.reasoningEngines.memories.operations.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.

      HTTP Method : GET

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}

      Path : v1/{+name}

      Parameter Order : name

      Parameters :

        name

          Type : string

          Location : path

          Description : The name of the operation resource.

          Required : Yes

          Pattern : ^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$

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

  • aiplatform.reasoningEngines.memories.operations.delete

      Path : v1/{+name}

      Parameter Order : 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`.

      HTTP Method : DELETE

      Parameters :

        name

          Location : path

          Required : Yes

          Pattern : ^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$

          Type : string

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

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

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}

  • aiplatform.reasoningEngines.memories.operations.wait

      Parameter Order : name

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

      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

          Type : string

          Location : path

          Required : Yes

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

          Pattern : ^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$

      HTTP Method : POST

      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.

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait

  • aiplatform.reasoningEngines.memories.operations.cancel

      HTTP Method : POST

      Parameter Order : name

      Path : v1/{+name}:cancel

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel

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

      Parameters :

        name

          Type : string

          Pattern : ^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$

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

          Location : path

          Required : Yes

      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.reasoningEngines.memories.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/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations

      HTTP Method : GET

      Parameters :

        returnPartialSuccess

          Location : query

          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.

        pageSize

          Description : The standard list page size.

          Type : integer

          Location : query

          Format : int32

        name

          Type : string

          Pattern : ^reasoningEngines/[^/]+/memories/[^/]+$

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

          Location : path

          Required : Yes

        filter

          Description : The standard list filter.

          Type : string

          Location : query

        pageToken

          Type : string

          Description : The standard list page token.

          Location : query

  • aiplatform.reasoningEngines.sessions.operations.cancel

      Path : v1/{+name}:cancel

      HTTP Method : POST

      Parameters :

        name

          Location : path

          Required : Yes

          Pattern : ^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$

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

          Type : string

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

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel

      Parameter Order : name

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

  • aiplatform.reasoningEngines.sessions.operations.delete

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

      Path : v1/{+name}

      Parameters :

        name

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

          Type : string

          Location : path

          Pattern : ^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$

          Required : Yes

      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

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}

      HTTP Method : DELETE

  • aiplatform.reasoningEngines.sessions.operations.list

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

      Path : v1/{+name}/operations

      HTTP Method : GET

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/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 :

        pageSize

          Description : The standard list page size.

          Location : query

          Format : int32

          Type : integer

        filter

          Type : string

          Description : The standard list filter.

          Location : query

        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

        pageToken

          Type : string

          Location : query

          Description : The standard list page token.

        name

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

          Location : path

          Type : string

          Pattern : ^reasoningEngines/[^/]+/sessions/[^/]+$

          Required : Yes

  • aiplatform.reasoningEngines.sessions.operations.wait

      Path : v1/{+name}:wait

      Parameter Order : name

      HTTP Method : POST

      Parameters :

        timeout

          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.

          Location : query

        name

          Required : Yes

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

          Type : string

          Location : path

          Pattern : ^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$

      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

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait

  • aiplatform.reasoningEngines.sessions.operations.get

      Parameter Order : name

      HTTP Method : GET

      Parameters :

        name

          Required : Yes

          Pattern : ^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$

          Location : path

          Type : string

          Description : The name of the operation resource.

      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

      Flat Path : v1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}

      Path : v1/{+name}