Stay organized with collections
Save and categorize content based on your preferences.
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 provides
client 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-in
authentication.
Built-in retries.
Idiomatic for each language.
Efficient
protocol buffer
HTTP request body.
Simple JSON interface.
Well supported by many Google and third-party tools and libraries.
You must build your own client.
You must
implement authentication.
You must implement retries.
Less efficient JSON HTTP request body.
REST streaming is not supported by this API.
You must generate your own client from Google-supplied protocol buffers.
You must
implement 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 using
protocol buffers.
In particular, the service uses
proto3.
In addition, when calling the REST API, the
default 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.
[[["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-28 UTC."],[],[],null,["# Notebooks API usage overview\n============================\n\n\nThis guide provides an overview of using the Notebooks API\nand its reference documentation.\n\nREST, gRPC, and client libraries\n--------------------------------\n\n\nYou can access the API via\n\nREST, gRPC, or one of the provided client libraries (built on gRPC).\n\n### Client libraries\n\n\nGoogle provides\n[client libraries](/vertex-ai/docs/workbench/reference/libraries)\nfor many popular languages to access this API.\nIf your desired programming language is supported by the client libraries,\nyou should use this option.\n\n### REST\n\n\nThis API supports\n[REST](https://en.wikipedia.org/wiki/Representational_state_transfer).\nSee the\n[REST reference](/vertex-ai/docs/workbench/reference/rest) for this API.\nAlso see\n[How to call Google APIs: REST edition](https://googleapis.github.io/HowToREST).\n\n### gRPC\n\n\nThis API supports\n[gRPC](https://grpc.io/).\nSee the\n[RPC reference](/vertex-ai/docs/workbench/reference/rpc) for this API,\nwhich provides a generic description of the types, methods,\nand fields generated for a gRPC library.\nAlso see\n[How to call Google APIs: RPC edition](https://googleapis.github.io/HowToRPC.html).\n\nType, method, and field names\n-----------------------------\n\n\nDepending on whether you are using\n\nclient libraries, REST, or gRPC,\n\nthe type, method, and field names for the API vary somewhat:\n\n- REST is arranged by resource hierarchies and their methods.\n- Client libraries and gRPC are arranged by services and their methods.\n- REST field names use camel case, though the API service will accept either camel case or snake case.\n- gRPC field names use snake case.\n- Client library field names use either title case, camel case or snake case, depending on which name is idiomatic for the language.\n\nProtocol buffers\n----------------\n\n\nWhether you are using\n\nclient libraries, REST, or gRPC,\n\nthe underlying service is defined using\n[protocol buffers](https://developers.google.com/protocol-buffers).\nIn particular, the service uses\n[proto3](https://developers.google.com/protocol-buffers/docs/proto3).\n\n\nWhen calling the API,\nsome request or response fields can require a basic understanding of\n[protocol buffer well-known types](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf).\n\n\nIn addition, when calling the REST API, the\n[default value](https://developers.google.com/protocol-buffers/docs/proto3#default)\nbehavior for protocol buffers may result in missing fields in a JSON response.\nThese fields are simply set to the default value,\nso they are not included in the response.\n\nAPI versions\n------------\n\n\nThe following API versions are available:\n\n- **v2** ([generally available](/products#product-launch-stages)) is for\n managing Vertex AI Workbench instances.\n\n- **v1** ([generally available](/products#product-launch-stages)) is for\n managing user-managed notebooks and managed notebooks instances.\n\n- **v1beta1** is scheduled for removal."]]
