Vertex AI API (aiplatform:v1beta1)

2025-11-03

5 new methods | 2 updated methods

Additions

    Methods
  • aiplatform.reasoningEngines.sandboxEnvironments.delete

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

      Parameter Order : name

      Path : v1beta1/{+name}

      HTTP Method : DELETE

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

      Parameters :

        name

          Required : Yes

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

          Type : string

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

          Location : path

      Description : Deletes the specific SandboxEnvironment.

  • aiplatform.reasoningEngines.sandboxEnvironments.list

      Parameter Order : parent

      HTTP Method : GET

      Description : Lists SandboxEnvironments in a given reasoning engine.

      Path : v1beta1/{+parent}/sandboxEnvironments

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

      Parameters :

        filter

          Location : query

          Type : string

          Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).

        pageToken

          Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.

          Location : query

          Type : string

        parent

          Location : path

          Required : Yes

          Pattern : ^reasoningEngines/[^/]+$

          Type : string

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

        pageSize

          Location : query

          Type : integer

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

          Format : int32

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

  • aiplatform.reasoningEngines.sandboxEnvironments.get

      Description : Gets details of the specific SandboxEnvironment.

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

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

      Path : v1beta1/{+name}

      HTTP Method : GET

      Parameters :

        name

          Required : Yes

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

          Location : path

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

          Type : string

      Parameter Order : name

  • aiplatform.reasoningEngines.sandboxEnvironments.create

      Parameter Order : parent

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

      HTTP Method : POST

      Description : Creates a SandboxEnvironment in a given reasoning engine.

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

      Path : v1beta1/{+parent}/sandboxEnvironments

      Parameters :

        parent

          Required : Yes

          Pattern : ^reasoningEngines/[^/]+$

          Location : path

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

          Type : string

  • aiplatform.reasoningEngines.sandboxEnvironments.execute

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

      Parameter Order : name

      HTTP Method : POST

      Path : v1beta1/{+name}:execute

      Description : Executes using a sandbox environment.

      Parameters :

        name

          Required : Yes

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

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

          Type : string

          Location : path

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

Updates

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

      Parameters :

        orderBy

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

          Location : query

          Type : string

  • aiplatform.reasoningEngines.sessions.events.list

      Parameters :

        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: * `timestamp` Example: `timestamp desc`.