Jupyter Notebook

Jupyter Notebook Terminals API

Terminal session management on the server.

Documentation GitHub OpenAPI

Operations 4

GET /api/terminals Jupyter Notebook List running terminals #

POST /api/terminals Jupyter Notebook Create a new terminal #

GET /api/terminals/{terminal_id} Jupyter Notebook Get terminal information #

DELETE /api/terminals/{terminal_id} Jupyter Notebook Shut down a terminal #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/jupyter-notebook-terminals-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Jupyter Notebook REST Terminals API
  description: REST API for managing and interacting with Jupyter Notebook servers, including kernels, sessions, contents (notebooks and files), terminals, and kernel specifications. This API is served by the Jupyter Notebook server (or Jupyter Server) and provides programmatic access to all notebook server functionality.
  version: 7.0.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  contact:
    name: Jupyter Project
    url: https://jupyter.org
    email: jupyter@googlegroups.com
servers:
- url: http://localhost:8888/api
  description: Local Jupyter Notebook server
security:
- token: []
- tokenHeader: []
tags:
- name: Terminals
  description: Terminal session management on the server.
paths:
  /api/terminals:
    get:
      operationId: listTerminals
      summary: Jupyter Notebook List running terminals
      description: Get the list of currently running terminal sessions.
      tags:
      - Terminals
      responses:
        '200':
          description: List of terminal sessions.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Terminal'
    post:
      operationId: createTerminal
      summary: Jupyter Notebook Create a new terminal
      description: Start a new terminal session.
      tags:
      - Terminals
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Desired name for the terminal session.
      responses:
        '200':
          description: Terminal session created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Terminal'
  /api/terminals/{terminal_id}:
    get:
      operationId: getTerminal
      summary: Jupyter Notebook Get terminal information
      description: Get details about a specific terminal session.
      tags:
      - Terminals
      parameters:
      - name: terminal_id
        in: path
        required: true
        description: Identifier for the terminal session.
        schema:
          type: string
      responses:
        '200':
          description: Terminal session details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Terminal'
        '404':
          description: Terminal not found.
    delete:
      operationId: deleteTerminal
      summary: Jupyter Notebook Shut down a terminal
      description: Shut down a terminal session by its ID.
      tags:
      - Terminals
      parameters:
      - name: terminal_id
        in: path
        required: true
        description: Identifier for the terminal session.
        schema:
          type: string
      responses:
        '204':
          description: Terminal shut down successfully.
        '404':
          description: Terminal not found.
components:
  schemas:
    Terminal:
      type: object
      description: A terminal session running on the server.
      properties:
        name:
          type: string
          description: Unique name identifier for the terminal session.
        last_activity:
          type: string
          format: date-time
          description: Timestamp of the last activity.
      required:
      - name
  securitySchemes:
    token:
      type: apiKey
      in: query
      name: token
      description: Authentication token passed as a query parameter.
    tokenHeader:
      type: apiKey
      in: header
      name: Authorization
      description: Authentication token passed in the Authorization header as 'token <token_value>'.

Jupyter Notebook Terminals API

Operations 4

Documentation

Specifications

Schemas & Data

Other Resources