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 Execution API

The Notebook Executions API is used to trigger, stop, and track notebook executions.

Celonis Notebook Execution 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 Execution. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 7 paths, and defines 7 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.

7 operations 7 paths 7 schemas 5 GET1 POST1 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 Execution 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 7

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

Notebook Execution 7

The Notebook Executions API is used to trigger, stop, and track notebook executions.

PUT
/api/executions/{id}/stop
Stop a running execution
stop 1 param → 200204400403500
POST
/api/executions
Trigger an execution
execute_1 body → 200204400403500
GET
/api/executions/{id}
Get an execution
find 1 param → 200204400403500
GET
/api/executions/{id}/logs
Get execution logs
getLogs_1 2 params → 200204400403500
GET
/api/executions/triggered/{id}
Get triggered executions
getTriggeredExecutions 5 params → 200204400403500
GET
/api/executions/triggered-groups
Get triggered execution groups
getTriggeredExecutionGroups 1 param → 200204400403500
GET
/api/executions/triggered-groups/{id}
Get triggered execution groups by ID
getTriggeredExecutionGroup 1 param → 200204400403500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are NotebookExecutionTransport (14 properties), PageNotebookExecutionTransport (8 properties), TriggeredExecutionGroupTransport (7 properties), NotebookExecutionLogTransport (4 properties). Each schema is shown below with its type and property counts.

TriggeredExecutionGroupTransport
object
7 properties
FrontendHandledBackendError
object
2 properties
ExceptionReference
object
3 properties
PageNotebookExecutionTransport
object
8 properties
JsonNode
NotebookExecutionTransport
object
14 properties 2 required
NotebookExecutionLogTransport
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

celonis-notebook-execution-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 API
Celonis Notebook Resources API
Celonis OpenAPI Tool Calling API
Celonis Permissions Export API API