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

Celonis Notebook API

The Notebook API is used to create, read, update, and delete notebooks.

Celonis Notebook API is one of 17 APIs that Celonis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 21 operations across 17 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version v1.2.0.

Requests are made against a single base URL, https://30f873b4-88d4-49ba-b327-6f651d7b99e6.remockly.com.

21 operations 17 paths 9 schemas 1 DELETE11 GET4 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.2.0
Base URL
https://{team_domain}.{realm}.celonis.cloud
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Celonis Notebook API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as AppKey (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 21

Across 17 paths, the API surfaces 21 operations — 1 DELETE, 11 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Notebook 21

The Notebook API is used to create, read, update, and delete notebooks.

GET
/api/notebooks/{id}
Get an app
findOne_1 1 param → 200204400403500
PUT
/api/notebooks/{id}
Update an app
update_1 1 param body → 200204400403500
DELETE
/api/notebooks/{id}
Delete an app
delete_1 1 param → 204400403500
PUT
/api/notebooks/{id}/upgrade
Upgrade app to the latest version
upgrade 1 param → 204400403500
PUT
/api/notebooks/{id}/probe
Check if an app is running
activeProbe 1 param → 204400403500
PUT
/api/notebooks/{id}/move
Move an app from one workspace to another
moveToWorkspace 2 params → 200204400403500
GET
/api/notebooks/{id}/app-key
Get the application key of the app
getApplicationKey 1 param → 200204400403500
PUT
/api/notebooks/{id}/app-key
Set an application key to the app
setApplicationKey 2 params → 204400403500
GET
/api/notebooks
List all notebooks
findAll_1 → 200204400403500
POST
/api/notebooks
Create an app
create_1 body → 201204400403500
POST
/api/notebooks/{id}/stop
Stop an app
stop_1 1 param → 200204400403500
POST
/api/notebooks/{id}/start
Start an app
start 1 param → 200204400403500
POST
/api/notebooks/{id}/open
Open an app
open 1 param → 200204400403500
GET
/api/notebooks/{id}/versions/latest
Get a list of all versions newer than the Notebook id version provided in the parameter
getAllNewVersions 1 param → 200204400403500
GET
/api/notebooks/{id}/llm/access-info
Get app's access information for LLM use case
getAccessInformationLLM 1 param → 200204400403500
GET
/api/notebooks/{id}/content
Get a list of all the files inside the app
getContents 2 params → 200204400403500
GET
/api/notebooks/{id}/access-info
Get access information for the app
getAccessInformation 1 param → 200204400403500
GET
/api/notebooks/versions
Get a list of all the versions of the app
getAllVersions → 200204400403500
GET
/api/notebooks/node
Check if team has dedicated service
hasDedicatedService → 200204400403500
GET
/api/notebooks/machine-learning-images
List all Machine Learning images
getMachineLearningImages → 200204400403500
GET
/api/notebooks/limit/reached
Check if the team has reached the maximum number of notebooks
limitReached → 200204400403500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are NotebookTransport (26 properties), NotebookAccessInformationTransport (19 properties), NotebookVersionTransport (9 properties), ApplicationKeyTransport (8 properties). Each schema is shown below with its type and property counts.

FrontendHandledBackendError
object
2 properties
NotebookTreeItem
object
7 properties
ApplicationKeyTransport
object
8 properties
ExceptionReference
object
3 properties
NotebookTransport
object
26 properties 3 required
NotebookResourcesTransport
object
4 properties 3 required
NotebookAccessInformationTransport
object
19 properties
ImageTransport
object
7 properties
NotebookVersionTransport
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celonis-notebook-api-openapi.yml Raw ↑

Other APIs Celonis publishes across the network.

Celonis Agents - Conversation API
Celonis Beta: OData Protocol API
Celonis Beta: Semantics for 3P AI Agents API
Celonis Data API
Celonis Job Execution API
Celonis Job Execution Group API
Celonis Login History API API
Celonis Members API API
Celonis Notebook Execution API
Celonis Notebook Resources API
Celonis OpenAPI Tool Calling API
Celonis Permissions Export API API