Notebooks API usage overview
This guide provides an overview of using the Notebooks API and its reference documentation.
REST, gRPC, and client libraries
You can access the API via REST, gRPC, or one of the provided client libraries (built on gRPC).
Client libraries
Google providesclient libraries for many popular languages to access this API. If your desired programming language is supported by the client libraries, you should use this option.
| Pros | Cons |
|---|---|
| Maintained by Google. Built-inauthentication. Built-in retries. Idiomatic for each language. Efficientprotocol buffer HTTP request body. | Not available for all programming languages. |
REST
This API supportsREST. See theREST reference for this API. Also seeHow to call Google APIs: REST edition.
| Pros | Cons |
|---|---|
| Simple JSON interface. Well supported by many Google and third-party tools and libraries. | You must build your own client. You mustimplement authentication. You must implement retries. Less efficient JSON HTTP request body. REST streaming is not supported by this API. |
gRPC
This API supportsgRPC. See theRPC reference for this API, which provides a generic description of the types, methods, and fields generated for a gRPC library. Also seeHow to call Google APIs: RPC edition.
| Pros | Cons |
|---|---|
| Supportsmany programming languages. Efficientprotocol buffer HTTP request body. | You must generate your own client from Google-supplied protocol buffers. You mustimplement authentication. You must implement retries. |
Type, method, and field names
Depending on whether you are using client libraries, REST, or gRPC, the type, method, and field names for the API vary somewhat:
- REST is arranged by resource hierarchies and their methods.
- Client libraries and gRPC are arranged by services and their methods.
- REST field names use camel case, though the API service will accept either camel case or snake case.
- gRPC field names use snake case.
- Client library field names use either title case, camel case or snake case, depending on which name is idiomatic for the language.
Protocol buffers
Whether you are using client libraries, REST, or gRPC, the underlying service is defined usingprotocol buffers. In particular, the service usesproto3.
When calling the API, some request or response fields can require a basic understanding ofprotocol buffer well-known types.
In addition, when calling the REST API, thedefault value behavior for protocol buffers may result in missing fields in a JSON response. These fields are simply set to the default value, so they are not included in the response.
API versions
The following API versions are available:
v2 (generally available) is formanaging Vertex AI Workbench instances.
v1 (generally available) is formanaging user-managed notebooks and managed notebooks instances.
v1beta1 is scheduled for removal.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-17 UTC.