Deepnote Public API v2
Notebooks API
Notebooks, their blocks, runs, and schedules.
Base URL
https://api.deepnote.com/v2Create a notebook
Creates an empty notebook inside the project identified by `projectId`.
/notebooksRequest body
CreateNotebookBodyprojectIdrequiredstring:uuidProject to create the notebook in.
namestringNotebook name.
Responses
▸201Notebook created
CreateNotebookResponsenotebookrequiredNotebook▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Project not found
ErrorResponsemessagerequiredstring▸409Project is suspended or duplicate notebook name
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstringGet a notebook
/notebooks/{notebookId}Parameters
notebookIdpathrequiredstringOpaque notebook identifier.
Responses
▸200Notebook details
objectnotebookrequiredobject▸400Validation error or project is suspended
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Notebook not found
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstringDelete a notebook
/notebooks/{notebookId}Parameters
notebookIdpathrequiredstringOpaque notebook identifier.
Responses
▸204Notebook deleted
▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Notebook not found
ErrorResponsemessagerequiredstring▸409Project is suspended
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstringReorder blocks in a notebook
Moves one or more active blocks as a group. Blocks omitted from `blockIds` keep their relative order.
/notebooks/{notebookId}/reorder-blocksParameters
notebookIdpathrequiredstringOpaque notebook identifier.
Request body
ReorderNotebookBlocksBodyblockIdsrequiredstring[]Non-empty list of unique block IDs to move, in the desired moved-block order.
placementrequiredReorderNotebookBlocksPlacementResponses
▸200Blocks reordered
ReorderNotebookBlocksResponseblockIdsrequiredstring[]Final active block order for the notebook.
▸400Validation error, e.g. unknown blockId or invalid placement
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Notebook not found
ErrorResponsemessagerequiredstring▸409Project is suspended
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstringList historical runs for a notebook
/notebooks/{notebookId}/runsParameters
notebookIdpathrequiredstringOpaque notebook identifier.
pageSizequeryintegerMaximum number of items to return. Defaults to 20. Maximum: 100.
pageTokenquerystringOpaque token returned by the previous page. Omit for the first page.
Responses
▸200Paginated list of runs
ListNotebookRunsResponserunsrequiredListNotebookRun[]paginationrequiredCursorPagination▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Notebook not found
ErrorResponsemessagerequiredstring▸409Project is suspended
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstringCreate or update a notebook schedule
Creates or replaces the schedule for the project that owns the notebook. Each project has at most one schedule; calling this endpoint with a different notebook in the same project silently re-points the schedule to the new notebook.
/notebooks/{notebookId}/scheduleParameters
notebookIdpathrequiredstringOpaque notebook identifier.
Request body
UpsertNotebookScheduleBodycronrequiredstringCron expression for the schedule (e.g. "0 9 * * 1-5").
timezonestringIANA timezone the cron expression runs in (e.g. "America/New_York").
Responses
▸200Schedule created or updated
UpsertNotebookScheduleResponseschedulerequiredNotebookSchedule▸400Validation error, e.g. invalid cron expression or timezone
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Notebook not found
ErrorResponsemessagerequiredstring▸409Project is suspended
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstring