Agent Platform API (aiplatform:v1beta1)

2026-09-04

21 new methods | 748 updated methods

Additions

    Methods

  • ▼ ▲ aiplatform.reasoningEngines.sandboxEnvironments.bidiExecute

      Description : Executes using a sandbox environment with bidirectional streaming.

      Path : v1beta1/{+name}:bidiExecute

      Parameter Order : name

      Parameters :

        name

          Location : path

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

          Required : Yes

          Description : Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`

          Type : string

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

      Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:bidiExecute

      HTTP Method : POST

  • ▼ ▲ aiplatform.projects.locations.interactionsHttp.create

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

      Parameter Order : parent

      Path : v1beta1/{+parent}/interactionsHttp

      HTTP Method : POST

      Parameters :

        parent

          Required : Yes

          Type : string

          Location : path

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

          Description : Required. The parent resource where this interaction will be created. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API only.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/interactionsHttp

      Description : Generates a set of responses from the model.

  • ▼ ▲ aiplatform.projects.locations.interactionsHttp.get

      Parameters :

        lastEventId

          Description : If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.

          Type : string

          Location : query

        name

          Location : path

          Type : string

          Description : Required. The name of the interaction to retrieve. Format: interactions/{interaction}

          Required : Yes

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

        stream

          Location : query

          Description : If true, streams the interaction events as Server-Sent Events.

          Type : boolean

        includeInput

          Description : If true, includes the input in the response.

          Deprecated : Yes

          Location : query

          Type : boolean

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

      Description : Gets an interaction.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/interactionsHttp/{interactionsHttpId}

      HTTP Method : GET

      Parameter Order : name

      Path : v1beta1/{+name}

  • ▼ ▲ aiplatform.projects.locations.interactionsHttp.cancel

      Path : v1beta1/{+name}/cancel

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/interactionsHttp/{interactionsHttpId}/cancel

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the interaction to cancel. Format: `interactions/{interaction}`.

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

          Required : Yes

          Type : string

          Location : path

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

      Parameter Order : name

      Description : Cancels an interaction.

  • ▼ ▲ aiplatform.projects.locations.taskStores.operations.cancel

      Path : v1beta1/{+name}:cancel

      Scopes :

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

      • Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/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`.

      HTTP Method : POST

      Parameters :

        name

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

          Location : path

          Type : string

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

          Required : Yes

      Parameter Order : name

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

      Parameters :

        name

          Description : The name of the operation resource.

          Type : string

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

          Required : Yes

          Location : path

      Parameter Order : name

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

      Path : v1beta1/{+name}

      Scopes :

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

      • HTTP Method : GET

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

      HTTP Method : POST

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

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}:wait

      Scopes :

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

      • Parameters :

        name

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

          Required : Yes

          Type : string

          Location : path

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

        timeout

          Type : string

          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.

          Format : google-duration

          Location : query

  • ▼ ▲ aiplatform.projects.locations.taskStores.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`.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}

      HTTP Method : DELETE

      Path : v1beta1/{+name}

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

      Parameter Order : name

      Parameters :

        name

          Required : Yes

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

          Type : string

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

          Location : path

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

      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.

          Type : boolean

          Location : query

        pageSize

          Location : query

          Type : integer

          Description : The standard list page size.

          Format : int32

        filter

          Type : string

          Description : The standard list filter.

          Location : query

        pageToken

          Description : The standard list page token.

          Type : string

          Location : query

        name

          Type : string

          Location : path

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

          Required : Yes

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

      Parameter Order : name

      Scopes :

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

      • HTTP Method : GET

      Path : v1beta1/{+name}/operations

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations

      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.taskStores.a2aTaskRecords.events.list

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

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}/events

      Parameter Order : parent

      HTTP Method : GET

      Path : v1beta1/{+parent}/events

      Parameters :

        filter

          Description : Optional. The standard list filter. Supported fields: * `create_time` range (i.e. `create_time>="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).

          Location : query

          Type : string

        orderBy

          Type : string

          Description : Optional. A comma-separated list of fields to order the results by. If this field is omitted, the results will be ordered by `generation` in ascending order. For each field, the default sort order is ascending. To specify descending order for a field, append a ` desc` suffix. For example: `create_time desc`. Supported fields: * `create_time` * `generation`

          Location : query

        parent

          Required : Yes

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

          Description : Required. The resource name of the A2ATaskRecord to list the TaskEvents under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`

          Type : string

          Location : path

        pageSize

          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. The maximum value is 100; values above 100 will be coerced to 100.

          Type : integer

          Format : int32

        pageToken

          Location : query

          Type : string

          Description : Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecordEvents call.

      Description : Lists TaskEvents for an A2ATaskRecord.

  • ▼ ▲ aiplatform.projects.locations.taskStores.a2aTaskRecords.appendEvents

      Parameter Order : name

      Path : v1beta1/{+name}:appendEvents

      Parameters :

        name

          Location : path

          Description : Required. The resource name of the A2ATaskRecord to append events to. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`

          Type : string

          Required : Yes

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

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}:appendEvents

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

      Description : Appends A2ATaskRecordEvents to an A2ATaskRecord.

      HTTP Method : POST

  • ▼ ▲ aiplatform.projects.locations.taskStores.a2aTaskRecords.delete

      HTTP Method : DELETE

      Description : Deletes an A2ATaskRecord.

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

      Path : v1beta1/{+name}

      Parameters :

        name

          Location : path

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

          Description : Required. The resource name of the A2ATaskRecord to delete. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`

          Required : Yes

          Type : string

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}

      Parameter Order : name

  • ▼ ▲ aiplatform.projects.locations.taskStores.a2aTaskRecords.list

      Path : v1beta1/{+parent}/a2aTaskRecords

      Parameter Order : parent

      Parameters :

        pageToken

          Description : Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecords call.

          Type : string

          Location : query

        filter

          Location : query

          Type : string

          Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `context_id` * `status.state` Example: `context_id="abc"`, `status.state="WORKING"`.

        parent

          Required : Yes

          Description : Required. The resource name of the TaskStore to list the A2ATaskRecords under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}`

          Type : string

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

          Location : path

        pageSize

          Format : int32

          Type : integer

          Location : query

          Description : Optional. The maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 100; values above 100 will be coerced to 100.

        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. If this field is omitted, the default ordering is `create_time` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` Example: `create_time desc`.

      Description : Lists A2ATaskRecords in a TaskStore.

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

      HTTP Method : GET

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords

  • ▼ ▲ aiplatform.projects.locations.taskStores.a2aTaskRecords.get

      HTTP Method : GET

      Description : Gets an A2ATaskRecord.

      Parameters :

        name

          Required : Yes

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

          Description : Required. The resource name of the A2ATaskRecord. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`

          Location : path

          Type : string

        view

          Type : string

          Enum :

        • A2A_TASK_RECORD_VIEW_UNSPECIFIED
        • A2A_TASK_RECORD_VIEW_BASIC
        • A2A_TASK_RECORD_VIEW_FULL

          • Description : Optional. The view of the A2ATaskRecord to return.

          Location : query

          Enum Descriptions :

        • Task view unspecified.
        • Task header only (status, metadata, timestamps)
        • Full materialized state (artifacts + history)

      Parameter Order : name

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

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}

      Path : v1beta1/{+name}

  • ▼ ▲ aiplatform.projects.locations.taskStores.a2aTaskRecords.create

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

      Description : Creates an A2ATaskRecord.

      Path : v1beta1/{+parent}/a2aTaskRecords

      Parameter Order : parent

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords

      Parameters :

        a2aTaskRecordId

          Description : Optional. The user defined ID to use for the A2ATaskRecord, which will become the final component of the A2ATaskRecord 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.

          Type : string

          Location : query

        parent

          Description : Required. The resource name of the TaskStore to create the A2ATaskRecord under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}`

          Location : path

          Type : string

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

          Required : Yes

      HTTP Method : POST

  • ▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.bidiExecute

      Path : v1beta1/{+name}:bidiExecute

      Description : Executes using a sandbox environment with bidirectional streaming.

      Parameter Order : name

      HTTP Method : POST

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

      Parameters :

        name

          Description : Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`

          Location : path

          Required : Yes

          Type : string

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

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:bidiExecute

  • ▼ ▲ aiplatform.taskStores.operations.get

      Parameters :

        name

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

          Required : Yes

          Type : string

          Location : path

          Description : The name of the operation resource.

      Path : v1beta1/{+name}

      Parameter Order : name

      Flat Path : v1beta1/taskStores/{taskStoresId}/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/aiplatform
    • https://www.googleapis.com/auth/cloud-platform

      • HTTP Method : GET

  • ▼ ▲ aiplatform.taskStores.operations.list

      HTTP Method : GET

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

      Path : v1beta1/{+name}/operations

      Scopes :

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

      • Parameter Order : name

      Parameters :

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

        pageSize

          Format : int32

          Description : The standard list page size.

          Type : integer

          Location : query

        name

          Location : path

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

          Pattern : ^taskStores/[^/]+$

          Type : string

          Required : Yes

        filter

          Type : string

          Description : The standard list filter.

          Location : query

        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

      Flat Path : v1beta1/taskStores/{taskStoresId}/operations

  • ▼ ▲ aiplatform.taskStores.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`.

      HTTP Method : DELETE

      Parameters :

        name

          Required : Yes

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

          Type : string

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

          Location : path

      Parameter Order : name

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

      Flat Path : v1beta1/taskStores/{taskStoresId}/operations/{operationsId}

      Path : v1beta1/{+name}

  • ▼ ▲ aiplatform.taskStores.operations.cancel

      Parameter Order : name

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

      HTTP Method : POST

      Flat Path : v1beta1/taskStores/{taskStoresId}/operations/{operationsId}:cancel

      Parameters :

        name

          Type : string

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

          Required : Yes

          Location : path

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

      Scopes :

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

  • ▼ ▲ aiplatform.taskStores.operations.wait

      Flat Path : v1beta1/taskStores/{taskStoresId}/operations/{operationsId}:wait

      Scopes :

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

      • Parameters :

        name

          Required : Yes

          Type : string

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

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

          Location : path

        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.

          Location : query

          Type : string

      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

      Path : v1beta1/{+name}:wait

      HTTP Method : POST

Updates