The Vertex AI Workbench application programming interface (API) is a
programmatic interface to the Vertex AI Workbench service.
Google builds the control-plane APIs on top of Kubernetes, using the
Kubernetes Resource Model (KRM). The control plane performs resource management
for services such as Notebook creation and deletion.

## About Vertex AI Workbench API

Vertex AI Workbench service currently supports only the
Kubernetes-based (KRM) API. Refer to the KRM page under
Vertex AI Workbench section for the User Interface (UI) equivalent
functionality.

> [!NOTE]
> **Note:** Currently, the Vertex AI Workbench KRM API doesn't support any functionality beyond the Vertex AI Workbench service provided in the UI. Therefore, if you choose to perform a KRM API action beyond the UI capability, there is no security guarantee or product support provided. If there is a need for supporting certain functionality on the UI, file a feature request to the Google Distributed Cloud (GDC) air-gapped product team.

## Service endpoint

The following URL is the API endpoint for the Vertex AI Workbench
service KRM API:

- https://<var translate="no">ORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT</var>/apis/aiplatform.gdc.goog/v1

Replace <var translate="no">ORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT</var> with the API
endpoint of your organization admin Kubernetes cluster.

## Discovery document

Use the `kubectl proxy --port=8001` command to open a proxy to the API server on
your local machine. From there, you can access the discovery document at the
following URL:

- http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1