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`.
post
/notebooksRequest body
required
application/json
CreateNotebookBodyprojectIdrequiredstring:uuidProject to create the notebook in.
namestringNotebook name.
Responses
▸201Notebook created
application/json
CreateNotebookResponsenotebookrequiredNotebook▸400Validation error
application/json
ErrorResponsemessagerequiredstring▸401Unauthorized
application/json
ErrorResponsemessagerequiredstring▸403Insufficient permissions
application/json
ErrorResponsemessagerequiredstring▸404Project not found
application/json
ErrorResponsemessagerequiredstring▸409Project is suspended or duplicate notebook name
application/json
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
application/json
ErrorResponsemessagerequiredstringGet a notebook
get
/notebooks/{notebookId}Parameters
notebookIdpathrequiredstringOpaque notebook identifier.
Responses
▸200Notebook details
application/json
objectnotebookrequiredobject▸400Validation error or project is suspended
application/json
ErrorResponsemessagerequiredstring▸401Unauthorized
application/json
ErrorResponsemessagerequiredstring▸403Insufficient permissions
application/json
ErrorResponsemessagerequiredstring▸404Notebook not found
application/json
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
application/json
ErrorResponsemessagerequiredstringDelete a notebook
delete
/notebooks/{notebookId}Parameters
notebookIdpathrequiredstringOpaque notebook identifier.
Responses
▸204Notebook deleted
▸400Validation error
application/json
ErrorResponsemessagerequiredstring▸401Unauthorized
application/json
ErrorResponsemessagerequiredstring▸403Insufficient permissions
application/json
ErrorResponsemessagerequiredstring▸404Notebook not found
application/json
ErrorResponsemessagerequiredstring▸409Project is suspended
application/json
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
application/json
ErrorResponsemessagerequiredstringReorder blocks in a notebook
Moves one or more active blocks as a group. Blocks omitted from `blockIds` keep their relative order.
post
/notebooks/{notebookId}/reorder-blocksParameters
notebookIdpathrequiredstringOpaque notebook identifier.
Request body
required
application/json
ReorderNotebookBlocksBodyblockIdsrequiredstring[]Non-empty list of unique block IDs to move, in the desired moved-block order.
placementrequiredReorderNotebookBlocksPlacementResponses
▸200Blocks reordered
application/json
ReorderNotebookBlocksResponseblockIdsrequiredstring[]Final active block order for the notebook.
▸400Validation error, e.g. unknown blockId or invalid placement
application/json
ErrorResponsemessagerequiredstring▸401Unauthorized
application/json
ErrorResponsemessagerequiredstring▸403Insufficient permissions
application/json
ErrorResponsemessagerequiredstring▸404Notebook not found
application/json
ErrorResponsemessagerequiredstring▸409Project is suspended
application/json
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
application/json
ErrorResponsemessagerequiredstringList historical runs for a notebook
get
/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
application/json
ListNotebookRunsResponserunsrequiredListNotebookRun[]paginationrequiredCursorPagination▸400Validation error
application/json
ErrorResponsemessagerequiredstring▸401Unauthorized
application/json
ErrorResponsemessagerequiredstring▸403Insufficient permissions
application/json
ErrorResponsemessagerequiredstring▸404Notebook not found
application/json
ErrorResponsemessagerequiredstring▸409Project is suspended
application/json
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
application/json
ErrorResponsemessagerequiredstring