Notebooks API

AI Platform Notebooks API (beta) is used to manage notebook resources in Google Cloud. AI Platform Notebooks API is in a pre-release state and might change or have limited support. For more information, see the product launch stages.


We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:


REST Resource: v1beta1.projects.locations

get GET /v1beta1/{name}
Gets information about a location.
list GET /v1beta1/{name}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta1.projects.locations.environments

create POST /v1beta1/{parent}/environments
Creates a new Environment.
delete DELETE /v1beta1/{name}
Deletes a single Environment.
get GET /v1beta1/{name}
Gets details of a single Environment.
list GET /v1beta1/{parent}/environments
Lists environments in a project.

REST Resource: v1beta1.projects.locations.instances

create POST /v1beta1/{parent}/instances
Creates a new Instance in a given project and location.
delete DELETE /v1beta1/{name}
Deletes a single Instance.
get GET /v1beta1/{name}
Gets details of a single Instance.
getIamPolicy GET /v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1beta1/{parent}/instances
Lists instances in a given project and location.
register POST /v1beta1/{parent}/instances:register
Registers an existing legacy notebook instance to the Notebooks API server.
report POST /v1beta1/{name}:report
Allows notebook instances to report their latest instance information to the Notebooks API server.
reset POST /v1beta1/{name}:reset
Resets a notebook instance.
setAccelerator PATCH /v1beta1/{name}:setAccelerator
Updates the guest accelerators of a single Instance.
setIamPolicy POST /v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource.
setLabels PATCH /v1beta1/{name}:setLabels
Updates the labels of an Instance.
setMachineType PATCH /v1beta1/{name}:setMachineType
Updates the machine type of a single Instance.
start POST /v1beta1/{name}:start
Starts a notebook instance.
stop POST /v1beta1/{name}:stop
Stops a notebook instance.
testIamPermissions POST /v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource.
upgrade POST /v1beta1/{name}:upgrade
Upgrades a notebook instance to the latest version.
upgradeInternal POST /v1beta1/{name}:upgradeInternal
Allows notebook instances to call this endpoint to upgrade themselves.

REST Resource: v1beta1.projects.locations.operations

cancel POST /v1beta1/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1beta1/{name}
Deletes a long-running operation.
get GET /v1beta1/{name}
Gets the latest state of a long-running operation.
list GET /v1beta1/{name}/operations
Lists operations that match the specified filter in the request.