# Celonis Machine Learning Workbench APIs

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

Default Server URL
```
/
```

## Download OpenAPI description

[Celonis Machine Learning Workbench APIs](https://developer.celonis.com/_bundle/mlwb/openapi/openapi.yaml)

## Notebook

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

### Get an app

 - [GET /api/notebooks/{id}](https://developer.celonis.com/mlwb/openapi/openapi/notebook/findone_1.md)

### Update an app

 - [PUT /api/notebooks/{id}](https://developer.celonis.com/mlwb/openapi/openapi/notebook/update_1.md)

### Delete an app

 - [DELETE /api/notebooks/{id}](https://developer.celonis.com/mlwb/openapi/openapi/notebook/delete_1.md)

### Upgrade app to the latest version

 - [PUT /api/notebooks/{id}/upgrade](https://developer.celonis.com/mlwb/openapi/openapi/notebook/upgrade.md)

### Check if an app is running

 - [PUT /api/notebooks/{id}/probe](https://developer.celonis.com/mlwb/openapi/openapi/notebook/activeprobe.md)

### Move an app from one workspace to another

 - [PUT /api/notebooks/{id}/move](https://developer.celonis.com/mlwb/openapi/openapi/notebook/movetoworkspace.md)

### Get the application key of the app

 - [GET /api/notebooks/{id}/app-key](https://developer.celonis.com/mlwb/openapi/openapi/notebook/getapplicationkey.md)

### Set an application key to the app

 - [PUT /api/notebooks/{id}/app-key](https://developer.celonis.com/mlwb/openapi/openapi/notebook/setapplicationkey.md)

### List all notebooks

 - [GET /api/notebooks](https://developer.celonis.com/mlwb/openapi/openapi/notebook/findall_1.md)

### Create an app

 - [POST /api/notebooks](https://developer.celonis.com/mlwb/openapi/openapi/notebook/create_1.md)

### Stop an app

 - [POST /api/notebooks/{id}/stop](https://developer.celonis.com/mlwb/openapi/openapi/notebook/stop_1.md)

### Start an app

 - [POST /api/notebooks/{id}/start](https://developer.celonis.com/mlwb/openapi/openapi/notebook/start.md)

### Open an app

 - [POST /api/notebooks/{id}/open](https://developer.celonis.com/mlwb/openapi/openapi/notebook/open.md)

### Get a list of all versions newer than the Notebook id version provided in the parameter

 - [GET /api/notebooks/{id}/versions/latest](https://developer.celonis.com/mlwb/openapi/openapi/notebook/getallnewversions.md)

### Get app's access information for LLM use case

 - [GET /api/notebooks/{id}/llm/access-info](https://developer.celonis.com/mlwb/openapi/openapi/notebook/getaccessinformationllm.md)

### Get a list of all the files inside the app

 - [GET /api/notebooks/{id}/content](https://developer.celonis.com/mlwb/openapi/openapi/notebook/getcontents.md)

### Get access information for the app

 - [GET /api/notebooks/{id}/access-info](https://developer.celonis.com/mlwb/openapi/openapi/notebook/getaccessinformation.md)

### Get a list of all the versions of the app

 - [GET /api/notebooks/versions](https://developer.celonis.com/mlwb/openapi/openapi/notebook/getallversions.md)

### Check if team has dedicated service

 - [GET /api/notebooks/node](https://developer.celonis.com/mlwb/openapi/openapi/notebook/hasdedicatedservice.md)

### List all Machine Learning images

 - [GET /api/notebooks/machine-learning-images](https://developer.celonis.com/mlwb/openapi/openapi/notebook/getmachinelearningimages.md)

### Check if the team has reached the maximum number of notebooks

 - [GET /api/notebooks/limit/reached](https://developer.celonis.com/mlwb/openapi/openapi/notebook/limitreached.md)

## Schedule

The Schedule API is used to create, read, update, and delete schedules.

### Get a schedule

 - [GET /api/scheduling/{id}](https://developer.celonis.com/mlwb/openapi/openapi/schedule/findone.md)

### Update a schedule

 - [PUT /api/scheduling/{id}](https://developer.celonis.com/mlwb/openapi/openapi/schedule/update.md)

### Delete a schedule

 - [DELETE /api/scheduling/{id}](https://developer.celonis.com/mlwb/openapi/openapi/schedule/delete.md)

### Enable or Disable a schedule

 - [PUT /api/scheduling/{id}/change-status](https://developer.celonis.com/mlwb/openapi/openapi/schedule/changestatus.md)

### List all schedules

 - [GET /api/scheduling](https://developer.celonis.com/mlwb/openapi/openapi/schedule/findall.md)

### Create a schedule

 - [POST /api/scheduling](https://developer.celonis.com/mlwb/openapi/openapi/schedule/create.md)

### Run a schedule

 - [POST /api/scheduling/{id}/run](https://developer.celonis.com/mlwb/openapi/openapi/schedule/runschedule.md)

### List all executions of a schedule

 - [GET /api/scheduling/{id}/executions](https://developer.celonis.com/mlwb/openapi/openapi/schedule/findallexecutions.md)

## Notebook Resources

The Notebook Resources API configures notebook resource such as CPU, memory, storage, and gpu.

### Get Notebook Resources

 - [GET /api/notebooks/{id}/resources](https://developer.celonis.com/mlwb/openapi/openapi/notebook-resources/getresources.md)

### Update Notebook Resources

 - [PUT /api/notebooks/{id}/resources](https://developer.celonis.com/mlwb/openapi/openapi/notebook-resources/updateresources.md)

## Notebook Execution

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

### Stop a running execution

 - [PUT /api/executions/{id}/stop](https://developer.celonis.com/mlwb/openapi/openapi/notebook-execution/stop.md)

### Trigger an execution

 - [POST /api/executions](https://developer.celonis.com/mlwb/openapi/openapi/notebook-execution/execute_1.md)

### Get an execution

 - [GET /api/executions/{id}](https://developer.celonis.com/mlwb/openapi/openapi/notebook-execution/find.md)

### Get execution logs

 - [GET /api/executions/{id}/logs](https://developer.celonis.com/mlwb/openapi/openapi/notebook-execution/getlogs_1.md)

### Get triggered executions

 - [GET /api/executions/triggered/{id}](https://developer.celonis.com/mlwb/openapi/openapi/notebook-execution/gettriggeredexecutions.md)

### Get triggered execution groups

 - [GET /api/executions/triggered-groups](https://developer.celonis.com/mlwb/openapi/openapi/notebook-execution/gettriggeredexecutiongroups.md)

### Get triggered execution groups by ID

 - [GET /api/executions/triggered-groups/{id}](https://developer.celonis.com/mlwb/openapi/openapi/notebook-execution/gettriggeredexecutiongroup.md)

## Job Execution

The Job Execution API is used to trigger, stop, and track job executions.

### Get all executions

 - [GET /api/jobs/{jobId}/executions](https://developer.celonis.com/mlwb/openapi/openapi/job-execution/getexecutions.md)

### Trigger an execution

 - [POST /api/jobs/{jobId}/executions](https://developer.celonis.com/mlwb/openapi/openapi/job-execution/execute.md)

### Update job application key

 - [POST /api/jobs/{jobId}/application-key](https://developer.celonis.com/mlwb/openapi/openapi/job-execution/updateapplicationkey.md)

### Stop a running execution

 - [POST /api/jobs/executions/{id}/stop](https://developer.celonis.com/mlwb/openapi/openapi/job-execution/stop_2.md)

### Get job execution logs

 - [GET /api/jobs/executions/{id}/logs](https://developer.celonis.com/mlwb/openapi/openapi/job-execution/getlogs.md)

### Get an execution

 - [GET /api/jobs/executions/{id}](https://developer.celonis.com/mlwb/openapi/openapi/job-execution/getexecution.md)

## Job Execution Group

The Job Execution Group API retrieves job execution groups.

### Get execution groups

 - [GET /api/jobs/executions/groups](https://developer.celonis.com/mlwb/openapi/openapi/job-execution-group/getexecutiongroups.md)