JupyterLab

JupyterLab Workspaces API

JupyterLab user workspaces.

GitHub OpenAPI

Operations 4

GET /workspaces JupyterLab List workspaces #
GET /workspaces/{space_name} JupyterLab Get workspace #
PUT /workspaces/{space_name} JupyterLab Update workspace #
DELETE /workspaces/{space_name} JupyterLab Delete workspace #

Documentation

📖
Documentation
https://jupyterlab-server.readthedocs.io/en/stable/api/rest.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/jupyterlab/openapi/jupyterlab-workspaces-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/jupyterlab/json-schema/jupyterlab-workspace.json
📊
JSONSchema
https://artifacts.apis.io/jupyterlab/json-schema/jupyterlab-setting.json

Other Resources

🔗
Repository
https://github.com/jupyterlab/jupyterlab_server
🔗
JSONLDContext
https://artifacts.apis.io/jupyterlab/json-ld/jupyterlab-context.jsonld

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/jupyterlab:jupyterlab-workspaces-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

jupyterlab-workspaces-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: JupyterLab Server REST Workspaces API
  description: REST API for JupyterLab Server, the set of REST API services that JupyterLab depends on. Provides endpoints for managing user-defined settings, workspaces, themes, translations, third-party license reports, and extension listings. JupyterLab Server runs as a Jupyter Server extension.
  version: 2.27.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  contact:
    name: Jupyter Project
    url: https://jupyterlab.readthedocs.io
    email: jupyter@googlegroups.com
servers:
- url: http://localhost:8888/lab/api
  description: Local JupyterLab server
security:
- token: []
tags:
- name: Workspaces
  description: JupyterLab user workspaces.
paths:
  /workspaces:
    get:
      operationId: listWorkspaces
      summary: JupyterLab List workspaces
      description: Returns the list of available JupyterLab workspaces for the current user.
      tags:
      - Workspaces
      responses:
        '200':
          description: List of workspace identifiers and metadata.
  /workspaces/{space_name}:
    get:
      operationId: getWorkspace
      summary: JupyterLab Get workspace
      description: Returns the named workspace, including layout data and metadata.
      tags:
      - Workspaces
      parameters:
      - name: space_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Workspace document.
    put:
      operationId: updateWorkspace
      summary: JupyterLab Update workspace
      description: Saves the named workspace.
      tags:
      - Workspaces
      parameters:
      - name: space_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Workspace saved.
    delete:
      operationId: deleteWorkspace
      summary: JupyterLab Delete workspace
      description: Deletes the named workspace.
      tags:
      - Workspaces
      parameters:
      - name: space_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Workspace deleted.
components:
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: 'Token-based authentication. Use the form: Authorization: token <token>'
    xsrf:
      type: apiKey
      in: header
      name: X-XSRFToken
      description: XSRF token required for browser-based requests.
externalDocs:
  description: JupyterLab Server REST API documentation
  url: https://jupyterlab-server.readthedocs.io/en/stable/api/rest.html