Deepnote API

The Deepnote API provides you with an endpoint to programmatically execute an existing notebook. This enables various automation use cases from customized scheduling to integrating notebooks deeper into your workflows together with other applications.

Authorization

To use the API, first you need to create an API key in your workspace's Settings & members > Security > API keys.

After creating your API key, you can use it to post requests to the Deepnote API. To use it, send it as bearer token in the Authorization header of your requests.

Authorization: Bearer INSERT_API_KEY

Execute notebook

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).

Parameters

Responses