Jupyter Notebook Contents API
File and directory management including notebooks, files, directories, and checkpoints.
Jupyter Notebook Contents API is one of 14 APIs that Jupyter Notebook publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Contents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.
This API exposes 8 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.
Requests are made against a single base URL, http://localhost:8888/api.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Jupyter Notebook Contents API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (token).
An API key is passed in the query as token (tokenQuery).
By default, every request must be authenticated.
token— Authentication token configured via KGAUTHTOKEN. Passed as 'token ' in the Authorization header.tokenQuery— Authentication token passed as a query parameter.
Paths & Operations 8
Across 3 paths, the API surfaces 8 operations — 2 DELETE, 2 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
File and directory management including notebooks, files, directories, and checkpoints.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Contents (12 properties), ContentsSave (5 properties), ContentsCreate (3 properties), Checkpoint (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Jupyter Notebook 12
Other APIs Jupyter Notebook publishes across the network.