Celonis Notebook Execution API
The Notebook Executions API is used to trigger, stop, and track notebook executions.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/celonis-notebook-execution-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Celonis Machine Learning Workbench Notebook Execution API
description: Documentation for the external Machine Learning APIs. These APIs allow you to trigger executions, manage resources, and more. To access the APIs, a Bearer API Key and a team-specific AppKey must be passed in the header.
version: v1.0
servers:
- description: Default Server URL
url: /
security:
- authorization: []
tags:
- name: Notebook Execution
description: The Notebook Executions API is used to trigger, stop, and track notebook executions.
paths:
/api/executions/{id}/stop:
put:
tags:
- Notebook Execution
summary: Stop a running execution
operationId: stop
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'204':
description: No Content
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/FrontendHandledBackendError'
'403':
description: Forbidden
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionReference'
/api/executions:
post:
tags:
- Notebook Execution
summary: Trigger an execution
operationId: execute_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotebookExecutionTransport'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/NotebookExecutionTransport'
'204':
description: No Content
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/FrontendHandledBackendError'
'403':
description: Forbidden
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionReference'
/api/executions/{id}:
get:
tags:
- Notebook Execution
summary: Get an execution
operationId: find
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/NotebookExecutionTransport'
'204':
description: No Content
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/FrontendHandledBackendError'
'403':
description: Forbidden
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionReference'
/api/executions/{id}/logs:
get:
tags:
- Notebook Execution
summary: Get execution logs
operationId: getLogs_1
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: logLevels
in: query
required: false
schema:
type: array
default:
- INFO
- DEBUG
- WARNING
- ERROR
items:
type: string
enum:
- DEBUG
- INFO
- WARNING
- ERROR
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/NotebookExecutionLogTransport'
'204':
description: No Content
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/FrontendHandledBackendError'
'403':
description: Forbidden
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionReference'
/api/executions/triggered/{id}:
get:
tags:
- Notebook Execution
operationId: getTriggeredExecutions
summary: Get triggered executions
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: pageIndex
in: query
required: false
schema:
type: integer
format: int32
default: 0
minimum: 0
- name: limit
in: query
required: false
schema:
type: integer
format: int32
default: 1
minimum: 1
- name: startedOrder
in: query
required: false
schema:
type: string
default: DESC
- name: executionSources
in: query
required: false
schema:
type: array
default:
- DATA_MODEL_RELOAD
- KNOWLEDGE_MODEL
- API
items:
type: string
enum:
- SCHEDULING
- API
- KNOWLEDGE_MODEL
- DATA_MODEL_RELOAD
- SKILL_UPDATE
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PageNotebookExecutionTransport'
'204':
description: No Content
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/FrontendHandledBackendError'
'403':
description: Forbidden
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionReference'
/api/executions/triggered-groups:
get:
tags:
- Notebook Execution
operationId: getTriggeredExecutionGroups
summary: Get triggered execution groups
parameters:
- name: notebookId
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/TriggeredExecutionGroupTransport'
'204':
description: No Content
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/FrontendHandledBackendError'
'403':
description: Forbidden
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionReference'
/api/executions/triggered-groups/{id}:
get:
tags:
- Notebook Execution
operationId: getTriggeredExecutionGroup
summary: Get triggered execution groups by ID
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/TriggeredExecutionGroupTransport'
'204':
description: No Content
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/FrontendHandledBackendError'
'403':
description: Forbidden
'500':
description: Internal Server Error
content:
'*/*':
schema:
$ref: '#/components/schemas/ExceptionReference'
components:
schemas:
TriggeredExecutionGroupTransport:
type: object
properties:
id:
type: string
notebookId:
type: string
notebookName:
type: string
executionFileName:
type: string
lastExecutionId:
type: string
lastExecutionStatus:
type: string
enum:
- CREATED
- QUEUED
- STARTING
- STARTED
- COMPLETED
- NOTEBOOK_ERROR
- FAILED
- TIMEOUT
- CANCELED
- RESOURCES_ERROR
- CONFIGURATION_ERROR
lastExecutionStartedDate:
type: string
format: date-time
ExceptionReference:
type: object
properties:
reference:
type: string
message:
type: string
shortMessage:
type: string
NotebookExecutionLogTransport:
type: object
properties:
notebookExecutionId:
type: string
message:
type: string
timestamp:
type: string
format: date-time
logLevel:
type: string
PageNotebookExecutionTransport:
type: object
properties:
content:
type: array
items:
$ref: '#/components/schemas/NotebookExecutionTransport'
pageSize:
type: integer
format: int32
pageNumber:
type: integer
format: int32
totalCount:
type: integer
format: int64
first:
type: boolean
last:
type: boolean
empty:
type: boolean
totalPages:
type: integer
format: int32
JsonNode: {}
FrontendHandledBackendError:
type: object
properties:
frontendErrorKey:
type: string
errorInformation: {}
NotebookExecutionTransport:
type: object
properties:
id:
type: string
notebookId:
type: string
notebookExecutionSourceId:
type: string
notebookExecutionSource:
type: string
executionFileName:
type: string
notebookExecutionStatus:
type: string
enum:
- CREATED
- QUEUED
- STARTING
- STARTED
- COMPLETED
- NOTEBOOK_ERROR
- FAILED
- TIMEOUT
- CANCELED
- RESOURCES_ERROR
- CONFIGURATION_ERROR
started:
type: string
format: date-time
completed:
type: string
format: date-time
params:
$ref: '#/components/schemas/JsonNode'
result:
type: string
logsOutputPath:
type: string
executionTimeout:
type: integer
format: int32
maxRetries:
type: integer
format: int32
timeUnit:
type: string
enum:
- NANOSECONDS
- MICROSECONDS
- MILLISECONDS
- SECONDS
- MINUTES
- HOURS
- DAYS
required:
- executionFileName
- notebookId