Features
Collaboration
Deepnote API
Environment
Integrations
Import & export
Deepnote for education
Security and privacy
Execute a notebook
The API is only available on Team and Enterprise plans.
POST https://api.deepnote.com/v1/projects/{project_id}/notebooks/{notebook_id}/execute
If the project's machine is offline, this starts the machine. If the notebook is already running, triggering this endpoint has no effect.
To find the project ID and notebook ID, open a Deepnote notebook in your browser and inspect the URL, it should be in the following format:
https://deepnote.com/workspace/{workspace name}-{workspace ID}/project/{project name}-{project ID}/notebook/{notebook name}-{notebook ID}
The project ID is a UUID with dashes (e.g. 25fcb3b2-cf3d-4c08-9b24-4306f1518caa) and the notebook ID is a UUID without dashes (e.g. abaf726ac4c34589961a588de29cd665).
Notebook ID is only available on the new version of notebooks. Learn more here.
Parameters
| Parameters | Example | Description |
|---|---|---|
| Path parameters | ||
project_id | The ID of the project that the notebook is located in. | |
notebook_id | The ID of the notebook. | |
| Header parameters | ||
Authorization | Bearer {API_KEY} | Your API key |
Responses
| Response code | Description |
|---|---|
202(Accepted) | The request was successfully received and the notebook was staged for execution. |
401(Unauthorized) | No API key was provided, or it's not associated with the workspace that owns the project, or the workspace is not on one of the required billing plans. |