Deepnote research: our notes on building agents
Get started
All endpoint groups

Deepnote Public API v2

Notebooks API

Notebooks, their blocks, runs, and schedules.

Base URL

https://api.deepnote.com/v2

Create a notebook

Creates an empty notebook inside the project identified by `projectId`.

post/notebooks

Request body

required
application/jsonCreateNotebookBody
projectIdrequiredstring:uuid

Project to create the notebook in.

namestring

Notebook name.

Responses

▸201Notebook created
application/jsonCreateNotebookResponse
notebookrequiredNotebook
▸400Validation error
application/jsonErrorResponse
messagerequiredstring
▸401Unauthorized
application/jsonErrorResponse
messagerequiredstring
▸403Insufficient permissions
application/jsonErrorResponse
messagerequiredstring
▸404Project not found
application/jsonErrorResponse
messagerequiredstring
▸409Project is suspended or duplicate notebook name
application/jsonErrorResponse
messagerequiredstring

Get a notebook

get/notebooks/{notebookId}

Parameters

notebookIdpathrequiredstring

Opaque notebook identifier.

Responses

▸200Notebook details
application/jsonobject
notebookrequiredobject
▸400Validation error or project is suspended
application/jsonErrorResponse
messagerequiredstring
▸401Unauthorized
application/jsonErrorResponse
messagerequiredstring
▸403Insufficient permissions
application/jsonErrorResponse
messagerequiredstring
▸404Notebook not found
application/jsonErrorResponse
messagerequiredstring

Delete a notebook

delete/notebooks/{notebookId}

Parameters

notebookIdpathrequiredstring

Opaque notebook identifier.

Responses

▸204Notebook deleted
▸400Validation error
application/jsonErrorResponse
messagerequiredstring
▸401Unauthorized
application/jsonErrorResponse
messagerequiredstring
▸403Insufficient permissions
application/jsonErrorResponse
messagerequiredstring
▸404Notebook not found
application/jsonErrorResponse
messagerequiredstring
▸409Project is suspended
application/jsonErrorResponse
messagerequiredstring

List historical runs for a notebook

get/notebooks/{notebookId}/runs

Parameters

notebookIdpathrequiredstring

Opaque notebook identifier.

pageSizequeryinteger

Maximum number of items to return. Defaults to 20. Maximum: 100.

pageTokenquerystring

Opaque token returned by the previous page. Omit for the first page.

Responses

▸200Paginated list of runs
application/jsonListNotebookRunsResponse
runsrequiredListNotebookRun[]
paginationrequiredCursorPagination
▸400Validation error
application/jsonErrorResponse
messagerequiredstring
▸401Unauthorized
application/jsonErrorResponse
messagerequiredstring
▸403Insufficient permissions
application/jsonErrorResponse
messagerequiredstring
▸404Notebook not found
application/jsonErrorResponse
messagerequiredstring
▸409Project is suspended
application/jsonErrorResponse
messagerequiredstring