Jupyter Notebooks

Jupyter Notebooks KernelSpecs API

Available kernel specs.

GitHub OpenAPI

Documentation

📖
Documentation
https://jupyter-server.readthedocs.io/en/latest/developers/rest-api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jupyter-notebooks/refs/heads/main/openapi/jupyter-notebooks-kernelspecs-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/jupyter-notebooks/refs/heads/main/json-schema/jupyter-notebook-format-schema.json

OpenAPI Specification

jupyter-notebooks-kernelspecs-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Jupyter Notebook Server REST Contents KernelSpecs API
  description: REST API for the Jupyter Notebook server, providing access to notebook contents, kernels, kernel specs, sessions, and terminals. Used by clients to drive interactive computing workflows.
  version: '7.0'
  contact:
    name: Project Jupyter
    url: https://jupyter.org
  license:
    name: BSD-3-Clause
    url: https://github.com/jupyter/notebook/blob/main/LICENSE
servers:
- url: http://localhost:8888/api
  description: Local Jupyter Notebook server
tags:
- name: KernelSpecs
  description: Available kernel specs.
paths:
  /kernelspecs:
    get:
      tags:
      - KernelSpecs
      summary: List installed kernel specs
      operationId: listKernelSpecs
      responses:
        '200':
          description: Available kernel specs and the default kernel name.
components:
  securitySchemes:
    tokenAuth:
      type: http
      scheme: bearer
      bearerFormat: Jupyter-Token