An idiomatic C++ client library for the Notebooks API. Use this API to programmatically manage notebooks in Google Cloud. Learn more about notebooks at the Vertex AI Workbench site.
While this library is GA, please note Google Cloud C++ client libraries do not follow Semantic Versioning.
Quickstart
The following shows the code that you'll run in the google/cloud/notebooks/quickstart/ directory, which should give you a taste of the Notebooks API C++ client library API.
This library offers multiple *Client classes, which are listed below. Each one of these classes exposes all the RPCs for a service as member functions of the class. This library groups multiple services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.
The library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the *Client classes when testing your application.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the Notebooks API C++ client library, which allows programmatic management of notebooks in Google Cloud.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the library is 2.37.0-rc, and there are multiple older versions available, ranging from 2.36.0 down to 2.11.0.\u003c/p\u003e\n"],["\u003cp\u003eThe library is considered Generally Available (GA), but it does not adhere to Semantic Versioning standards.\u003c/p\u003e\n"],["\u003cp\u003eThe library offers several client classes, such as \u003ccode\u003enotebooks_v1::ManagedNotebookServiceClient\u003c/code\u003e, \u003ccode\u003enotebooks_v1::NotebookServiceClient\u003c/code\u003e, and \u003ccode\u003enotebooks_v2::NotebookServiceClient\u003c/code\u003e, which expose the APIs for their respective services.\u003c/p\u003e\n"],["\u003cp\u003eThe page offers further information on topics such as error handling, how to override the default endpoint or authentication credentials, how to override retry policies and backoff, and information about environment variables.\u003c/p\u003e\n"]]],[],null,["Version latestkeyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/notebooks/latest)\n- [2.41.0](/cpp/docs/reference/notebooks/2.41.0)\n- [2.40.0](/cpp/docs/reference/notebooks/2.40.0)\n- [2.39.0](/cpp/docs/reference/notebooks/2.39.0)\n- [2.38.0](/cpp/docs/reference/notebooks/2.38.0)\n- [2.37.0](/cpp/docs/reference/notebooks/2.37.0)\n- [2.36.0](/cpp/docs/reference/notebooks/2.36.0)\n- [2.35.0](/cpp/docs/reference/notebooks/2.35.0)\n- [2.34.0](/cpp/docs/reference/notebooks/2.34.0)\n- [2.33.0](/cpp/docs/reference/notebooks/2.33.0)\n- [2.32.0](/cpp/docs/reference/notebooks/2.32.0)\n- [2.31.0](/cpp/docs/reference/notebooks/2.31.0)\n- [2.30.0](/cpp/docs/reference/notebooks/2.30.0)\n- [2.29.0](/cpp/docs/reference/notebooks/2.29.0)\n- [2.28.0](/cpp/docs/reference/notebooks/2.28.0)\n- [2.27.0](/cpp/docs/reference/notebooks/2.27.0)\n- [2.26.0](/cpp/docs/reference/notebooks/2.26.0)\n- [2.25.1](/cpp/docs/reference/notebooks/2.25.1)\n- [2.24.0](/cpp/docs/reference/notebooks/2.24.0)\n- [2.23.0](/cpp/docs/reference/notebooks/2.23.0)\n- [2.22.1](/cpp/docs/reference/notebooks/2.22.1)\n- [2.21.0](/cpp/docs/reference/notebooks/2.21.0)\n- [2.20.0](/cpp/docs/reference/notebooks/2.20.0)\n- [2.19.0](/cpp/docs/reference/notebooks/2.19.0)\n- [2.18.0](/cpp/docs/reference/notebooks/2.18.0)\n- [2.17.0](/cpp/docs/reference/notebooks/2.17.0)\n- [2.16.0](/cpp/docs/reference/notebooks/2.16.0)\n- [2.15.1](/cpp/docs/reference/notebooks/2.15.1)\n- [2.14.0](/cpp/docs/reference/notebooks/2.14.0)\n- [2.13.0](/cpp/docs/reference/notebooks/2.13.0)\n- [2.12.0](/cpp/docs/reference/notebooks/2.12.0)\n- [2.11.0](/cpp/docs/reference/notebooks/2.11.0) \n\nNotebooks API C++ Client Library\n================================\n\nAn idiomatic C++ client library for the [Notebooks API](https://cloud.google.com/vertex-ai/docs/workbench). Use this API to programmatically manage notebooks in Google Cloud. Learn more about notebooks at the [Vertex AI Workbench](https://cloud.google.com/vertex-ai-workbench) site.\n\nWhile this library is **GA** , please note Google Cloud C++ client libraries do **not** follow [Semantic Versioning](https://semver.org/).\n\n### Quickstart\n\nThe following shows the code that you'll run in the `google/cloud/notebooks/quickstart/` directory, which should give you a taste of the Notebooks API C++ client library API. \n\n #include \"google/cloud/notebooks/v2/notebook_client.h\"\n #include \"google/cloud/location.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 3) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id location-id\\n\";\n return 1;\n }\n\n auto const location = google::cloud::Location(argv[1], argv[2]);\n\n namespace notebooks = ::google::cloud::notebooks_v2;\n auto client = notebooks::NotebookServiceClient(\n notebooks::MakeNotebookServiceConnection());\n\n for (auto i : client.ListInstances(location.FullName())) {\n if (!i) throw std::move(i).status();\n std::cout \u003c\u003c i-\u003eDebugString() \u003c\u003c \"\\n\";\n }\n\n return 0;\n } catch (google::cloud::Status const& status) {\n std::cerr \u003c\u003c \"google::cloud::Status thrown: \" \u003c\u003c status \u003c\u003c \"\\n\";\n return 1;\n }\n\n### Main classes\n\nThis library offers multiple `*Client` classes, which are listed below. Each one of these classes exposes all the RPCs for a service as member functions of the class. This library groups multiple services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.\n\nThe library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the `*Client` classes when testing your application.\n\n- [`notebooks_v1::ManagedNotebookServiceClient`](/cpp/docs/reference/notebooks/latest/classgoogle_1_1cloud_1_1notebooks__v1_1_1ManagedNotebookServiceClient)\n- [`notebooks_v1::NotebookServiceClient`](/cpp/docs/reference/notebooks/latest/classgoogle_1_1cloud_1_1notebooks__v1_1_1NotebookServiceClient)\n- [`notebooks_v2::NotebookServiceClient`](/cpp/docs/reference/notebooks/latest/classgoogle_1_1cloud_1_1notebooks__v2_1_1NotebookServiceClient)\n\n### More Information\n\n- [Error Handling](https://cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.\n- [How to Override the Default Endpoint](/cpp/docs/reference/notebooks/latest/notebooks-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/notebooks/latest/notebooks-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Override Retry, Backoff, and Idempotency Policies](/cpp/docs/reference/notebooks/latest/notebooks-override-retry) - describes how to change the default retry policies.\n- [Environment Variables](/cpp/docs/reference/notebooks/latest/notebooks-env) - describes environment variables that can configure the behavior of the library."]]