Stay organized with collections
Save and categorize content based on your preferences.
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.
Service endpoint
The following URL is the API endpoint for the Vertex AI Workbench
service KRM API:
Replace ORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT 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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[[["\u003cp\u003eThe Vertex AI Workbench API is a programmatic interface to the Vertex AI Workbench service, built on Kubernetes using the Kubernetes Resource Model (KRM) for resource management like Notebook creation and deletion.\u003c/p\u003e\n"],["\u003cp\u003eCurrently, the Vertex AI Workbench service only supports the Kubernetes-based (KRM) API, and its UI equivalent functionality can be found on the KRM page under the Vertex AI Workbench section.\u003c/p\u003e\n"],["\u003cp\u003eThe Vertex AI Workbench KRM API's functionality is currently limited to the features available in the UI, with no security guarantees or product support for actions beyond the UI capabilities.\u003c/p\u003e\n"],["\u003cp\u003eThe API endpoint for the Vertex AI Workbench service KRM API is https://\u003cvar translate=no\u003eORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT\u003c/var\u003e/apis/aiplatform.gdc.goog/v1, where \u003cvar translate=no\u003eORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT\u003c/var\u003e should be replaced with the admin cluster's API endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe discovery document for the API can be accessed via a local proxy by using \u003ccode\u003ekubectl proxy --port=8001\u003c/code\u003e and then navigating to http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1.\u003c/p\u003e\n"]]],[],null,["# Vertex AI Workbench API overview\n\nThe Vertex AI Workbench application programming interface (API) is a\nprogrammatic interface to the Vertex AI Workbench service.\nGoogle builds the control-plane APIs on top of Kubernetes, using the\nKubernetes Resource Model (KRM). The control plane performs resource management\nfor services such as Notebook creation and deletion.\n\nAbout Vertex AI Workbench API\n-----------------------------\n\nVertex AI Workbench service currently supports only the\nKubernetes-based (KRM) API. Refer to the KRM page under\nVertex AI Workbench section for the User Interface (UI) equivalent\nfunctionality.\n| **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.\n\nService endpoint\n----------------\n\nThe following URL is the API endpoint for the Vertex AI Workbench\nservice KRM API:\n\n- https://\u003cvar translate=\"no\"\u003eORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT\u003c/var\u003e/apis/aiplatform.gdc.goog/v1\n\nReplace \u003cvar translate=\"no\"\u003eORG_ADMIN_CLUSTER_KUBERNETES_API_ENDPOINT\u003c/var\u003e with the API\nendpoint of your organization admin Kubernetes cluster.\n\nDiscovery document\n------------------\n\nUse the `kubectl proxy --port=8001` command to open a proxy to the API server on\nyour local machine. From there, you can access the discovery document at the\nfollowing URL:\n\n- http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1"]]
