How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 7.0.0.

Requests are made against a single base URL, http://localhost:8888/api.

8 operations 3 paths 4 schemas 2 DELETE2 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
7.0.0
Base URL
http://localhost:8888/api
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Jupyter Notebook Contents API declares 2 security schemes for authenticating requests. An API key is passed in the query as token (token). An API key is passed in the header as Authorization (tokenHeader). By default, every request must be authenticated.

  • token — Authentication token passed as a query parameter.
  • tokenHeader — Authentication token passed in the Authorization header as 'token '.

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.

Contents 8

File and directory management including notebooks, files, directories, and checkpoints.

GET
/api/contents/{path}
Jupyter Notebook Get contents
getContents 5 params → 200400404
POST
/api/contents/{path}
Jupyter Notebook Create a new file or directory
createContent 1 param body → 201404
PUT
/api/contents/{path}
Jupyter Notebook Save or upload content
updateContent 1 param body → 200201400
PATCH
/api/contents/{path}
Jupyter Notebook Rename a file or directory
renameContent 1 param body → 200400404
DELETE
/api/contents/{path}
Jupyter Notebook Delete a file or directory
deleteContent 1 param → 204400404
GET
/api/contents/{path}/checkpoints
Jupyter Notebook List checkpoints
listCheckpoints 1 param → 200404
POST
/api/contents/{path}/checkpoints
Jupyter Notebook Create a checkpoint
createCheckpoint 1 param → 201404
DELETE
/api/contents/{path}/checkpoints/{checkpoint_id}
Jupyter Notebook Delete a checkpoint
deleteCheckpoint 2 params → 204404

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.

ContentsSave
object
Request body for saving content.
5 properties 1 required
ContentsCreate
object
Request body for creating new content.
3 properties
Contents
object
A contents model representing a file, directory, or notebook in the Jupyter file system.
12 properties 6 required
Checkpoint
object
A checkpoint (snapshot) of a file.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-notebook-contents-api-openapi.yml Raw ↑

Other APIs Jupyter Notebook publishes across the network.

Jupyter Kernel Messaging Protocol
Jupyter Notebook Authorization API
Jupyter Notebook Config API
Jupyter Notebook General API
Jupyter Notebook Groups API
Jupyter Notebook Hub API
Jupyter Notebook Kernels API
Jupyter Notebook Kernelspecs API
Jupyter Notebook Proxy API
Jupyter Notebook Services API
Jupyter Notebook Sessions API
Jupyter Notebook Terminals API
Where this information came from

This is an independent, third-party profile of Jupyter Notebook Contents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.