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

Deepnote Public API v2

Projects API

Projects and their contents.

Base URL

https://api.deepnote.com/v2

List projects

get/projects

Parameters

pageSizequeryinteger

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

pageTokenquerystring

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

nameContainsquerystring

Filter projects whose name contains this value (case-insensitive).

Responses

▸200Paginated list of projects
application/jsonListProjectsResponse
projectsrequiredListProjectsItem[]
paginationrequiredCursorPagination
▸400Validation error
application/jsonErrorResponse
messagerequiredstring
▸401Unauthorized
application/jsonErrorResponse
messagerequiredstring
▸403Insufficient permissions
application/jsonErrorResponse
messagerequiredstring
▸429Rate limit exceeded
application/jsonErrorResponse
messagerequiredstring

Create a project

post/projects

Request body

required
application/jsonCreateProjectBody
namerequiredstring

Project name.

folderIdstring:uuid

Folder to create the project in. Omit to create at the workspace root.

projectType"standard" | "notebook" | "agent"

Project type. Omit to create a `standard` project; `notebook` creates a single-notebook project; `agent` creates an Agent project.

Responses

▸201Project created
application/jsonCreateProjectResponse
projectrequiredobject
▸400Validation error
application/jsonErrorResponse
messagerequiredstring
▸401Unauthorized
application/jsonErrorResponse
messagerequiredstring
▸403Insufficient permissions
application/jsonErrorResponse
messagerequiredstring
▸404Folder not found
application/jsonErrorResponse
messagerequiredstring
▸429Rate limit exceeded
application/jsonErrorResponse
messagerequiredstring

Get a project

get/projects/{projectId}

Parameters

projectIdpathrequiredstring:uuid

Responses

▸200Project details
application/jsonGetProjectResponse
projectrequiredobject
▸400Validation error
application/jsonErrorResponse
messagerequiredstring
▸401Unauthorized
application/jsonErrorResponse
messagerequiredstring
▸403Insufficient permissions
application/jsonErrorResponse
messagerequiredstring
▸404Project not found
application/jsonErrorResponse
messagerequiredstring
▸409Project is suspended
application/jsonErrorResponse
messagerequiredstring
▸429Rate limit exceeded
application/jsonErrorResponse
messagerequiredstring

Delete a project

delete/projects/{projectId}

Parameters

projectIdpathrequiredstring:uuid

Responses

▸204Project deleted
▸400Validation error
application/jsonErrorResponse
messagerequiredstring
▸401Unauthorized
application/jsonErrorResponse
messagerequiredstring
▸403Insufficient permissions
application/jsonErrorResponse
messagerequiredstring
▸404Project not found
application/jsonErrorResponse
messagerequiredstring
▸429Rate limit exceeded
application/jsonErrorResponse
messagerequiredstring

Export a project as a ZIP archive

Returns a ZIP archive containing one `.deepnote` YAML document per notebook. Block outputs and per-run execution metadata are excluded.

get/projects/{projectId}/export

Parameters

projectIdpathrequiredstring:uuid

Responses

▸200ZIP archive containing the project notebooks
application/zipstring:binary
▸400Validation error
application/jsonErrorResponse
messagerequiredstring
▸401Unauthorized
application/jsonErrorResponse
messagerequiredstring
▸404Project not found
application/jsonErrorResponse
messagerequiredstring
▸409Project is suspended
application/jsonErrorResponse
messagerequiredstring
▸422The project contains block types that cannot be represented in a `.deepnote` document, or its requirements.txt is too large to parse
application/jsonErrorResponse
messagerequiredstring
▸429Rate limit exceeded
application/jsonErrorResponse
messagerequiredstring