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 Sessions API

Session management for associating notebooks with running kernels.

Jupyter Notebook Sessions 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 Sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

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

5 operations 2 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Jupyter Notebook Sessions 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Sessions 5

Session management for associating notebooks with running kernels.

GET
/api/sessions
Jupyter Notebook List running sessions
listSessions → 200
POST
/api/sessions
Jupyter Notebook Create a new session
createSession body → 201501
GET
/api/sessions/{session_id}
Jupyter Notebook Get a session
getSession 1 param → 200404
PATCH
/api/sessions/{session_id}
Jupyter Notebook Update a session
updateSession 1 param body → 200400404
DELETE
/api/sessions/{session_id}
Jupyter Notebook Delete a session
deleteSession 1 param → 204404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Session (5 properties), Kernel (5 properties), SessionUpdate (4 properties), SessionCreate (4 properties). Each schema is shown below with its type and property counts.

SessionCreate
object
Request body for creating a new session.
4 properties 3 required
Kernel
object
A running kernel instance.
5 properties 5 required
SessionUpdate
object
Request body for updating a session.
4 properties
Session
object
A notebook session, associating a notebook with a kernel.
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-notebook-sessions-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 Contents 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 Terminals API
Where this information came from

This is an independent, third-party profile of Jupyter Notebook Sessions 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.