Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wherobots jupyter_lab API

The jupyter_lab API from Wherobots — 5 operation(s) for jupyter_lab.

Wherobots jupyter_lab API is one of 34 APIs that Wherobots publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include jupyter_lab. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 29 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.cloud.wherobots.com.

6 operations 5 paths 29 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.cloud.wherobots.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Wherobots jupyter_lab API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerToken). An API key is passed in the header as X-API-Key (wherobotsApiKey).

  • wherobotsApiKey — A Wherobots-generated API key

Paths & Operations 6

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

jupyter_lab 6
GET
/me/jupyter/lab/instance/{notebook_id}
Get a notebook instance
getNotebookInstance 1 param → 200400401403404409422500
GET
/me/jupyter/lab/instance-latest
Get user's latest notebook instance
latestNotebookInstance → 200400401403404409422500
GET
/me/jupyter/lab/instance
List notebook instances
listNotebookInstances 4 params → 200400401403404409422500
POST
/me/jupyter/lab/instance
Create a notebook instance
createNotebookInstance 1 param body → 200400401403404409422500
POST
/me/jupyter/lab/instance/{notebook_id}/destroy
Destroy a notebook instance
destroyNotebookInstance 1 param → 200400401403404409422500
GET
/me/jupyter/lab/config-hint
Get notebook config hints
getNotebookConfigHint → 200400401403404409422500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are JupyterKubeApp (13 properties), JupyterListModel (11 properties), RuntimeHintItem (9 properties), ErrorInfo (7 properties). Each schema is shown below with its type and property counts.

RuntimesHint
object
1 property 1 required
JupyterListModelEvent
object
5 properties 4 required
RuntimeHintItem
object
9 properties 7 required
ErrorInfo
object
7 properties 4 required
RuntimeSize
string
GpuType
string
AppStatus
string
JupyterListModel
object
11 properties 8 required
KubeAppCreationMeta
object
eventmeta shape for EventCode.APPSTARTCREATION. Captures decisions pinned at kubeapp creation time so cancel/destroy can consult them later without re-deriving…
1 property
AppType
string
ComputeClusterAvailability
string
JupyterKubeApp
object
13 properties 10 required
ErrorBody
object
2 properties 2 required
RuntimeTag
string
InstanceDetailsHint
object
3 properties
RuntimeId
string
Region
object
4 properties 3 required
JupyterConfigHint
object
6 properties 6 required
RegionsHint
object
2 properties 2 required
NodeSchedulingMeta
object
Metadata captured at node-scheduling time. nodepreexisted is True when the pod landed on a node that existed before the pod was created, False when the node wa…
4 properties 4 required
KubeAppEvent
object
6 properties 3 required
RunEventMeta
object
2 properties
JupyterAPIPayload
object
6 properties
VersionHint
object
2 properties 2 required
ErrorClass
string
IntHint
object
4 properties 2 required
JupyterAppMeta
object
Jupyter-specific metadata fields
4 properties
WherobotsVersion
object
3 properties 2 required
RuntimeTagsHint
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wherobots-jupyter-lab-api-openapi.yml Raw ↑

Other APIs Wherobots publishes across the network.

Wherobots apikey API
Wherobots audit-log API
Wherobots catalogs API
Wherobots cloud-connections API
Wherobots coupon API
Wherobots environment-override--preset API
Wherobots environment-preset API
Wherobots files API
Wherobots Flags API
Wherobots foreign-catalog API
Wherobots Health API
Wherobots Is Super User API