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

Nuon notebooks API

notebooks

Nuon notebooks API is one of 18 APIs that Nuon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include notebooks. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 7 paths, and defines 30 schemas. It is described by OpenAPI 2.0, at version 0.19.1074.

Requests are made against the base URL https://api.nuon.co.

12 operations 7 paths 30 schemas 2 DELETE4 GET2 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
0.19.1074
Base URL
https://api.nuon.co
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Nuon notebooks API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (APIKey). An API key is passed in the header as X-Nuon-Org-ID (OrgID).

  • APIKey — Type "Bearer" followed by a space and token.
  • OrgID — Nuon org ID

Paths & Operations 12

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

notebooks 12

notebooks

GET
/v1/installs/{install_id}/notebooks
list notebooks for an install
GetNotebooks 4 params → 200
POST
/v1/installs/{install_id}/notebooks
create a notebook for an install
CreateNotebook 2 params → 201
DELETE
/v1/installs/{install_id}/notebooks/{notebook_id}
delete a notebook
DeleteNotebook 2 params → 204
GET
/v1/installs/{install_id}/notebooks/{notebook_id}
get a notebook with its ordered cells and each cell's latest run
GetNotebook 2 params → 200
PATCH
/v1/installs/{install_id}/notebooks/{notebook_id}
update a notebook
UpdateNotebook 3 params → 200
POST
/v1/installs/{install_id}/notebooks/{notebook_id}/cells
add a cell to a notebook
CreateNotebookCell 3 params → 201
PUT
/v1/installs/{install_id}/notebooks/{notebook_id}/cells/reorder
reorder a notebook's cells
ReorderNotebookCells 3 params → 200
DELETE
/v1/installs/{install_id}/notebooks/{notebook_id}/cells/{cell_id}
delete a cell
DeleteNotebookCell 3 params → 204
PATCH
/v1/installs/{install_id}/notebooks/{notebook_id}/cells/{cell_id}
edit a cell (bumps its revision)
UpdateNotebookCell 4 params → 200
GET
/v1/installs/{install_id}/notebooks/{notebook_id}/cells/{cell_id}/runs
list a cell's run history (newest first)
GetNotebookCellRuns 5 params → 200
POST
/v1/installs/{install_id}/notebooks/{notebook_id}/cells/{cell_id}/runs
run a notebook cell on the install's runner
RunNotebookCell 4 params → 202
GET
/v1/installs/{install_id}/notebooks/{notebook_id}/runs/{run_id}
get a single cell run (includes logstreamid for tailing)
GetNotebookCellRun 3 params → 200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are app.NotebookCellRun (22 properties), app.QueueEmitter (21 properties), app.QueueSignal (20 properties), app.Queue (16 properties). Each schema is shown below with its type and property counts.

service.CreateNotebookRequest
object
2 properties
app.QueueEmitter
object
21 properties
app.Notebook
object
13 properties
signaldb.SignalData
object
1 property
app.CompositeStatus
object
6 properties
app.RoleType
string
app.Role
object
7 properties
service.CreateCellRequest
object
7 properties
permissions.Permission
string
app.Queue
object
16 properties
app.QueueSignal
object
20 properties
service.UpdateNotebookRequest
object
3 properties
permissions.Set
object
app.Account
object
10 properties
app.QueueEmitterMode
string
app.Status
string
app.Policy
object
7 properties
app.AccountType
string
app.NotebookCellRun
object
22 properties
app.PolicyName
string
cctx.SignalContext
object
4 properties
service.UpdateCellRequest
object
7 properties
callback.Ref
object
3 properties
service.ReorderCellsRequest
object
1 property 1 required
sql.NullBool
object
2 properties
app.UserJourney
object
3 properties
service.RunCellRequest
object
1 property
app.NotebookCell
object
15 properties
signaldb.WorkflowRef
object
3 properties
app.UserJourneyStep
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuon-notebooks-api-openapi.yml Raw ↑

Other APIs Nuon publishes across the network.

Nuon accounts API
Nuon actions API
Nuon actions/runner API
Nuon apps API
Nuon auth API
Nuon components API
Nuon general API
Nuon installs API
Nuon onboarding API
Nuon orgs API
Nuon policy-reports API
Nuon queues API