Deepnote Public API v2
Files API
Project files and folders.
Base URL
https://api.deepnote.com/v2Create a file
Creates a file at the requested project path from a multipart upload or a JSON body. When that path already exists, a unique path is generated unless `overwrite` is set. Use multipart for large files.
/filesRequest body
CreateFileMultipartBodyprojectIdrequiredstring:uuidProject to create the file in.
pathrequiredstringRequested destination path within the project. If it already exists and `overwrite` is not set, a unique path is generated.
overwrite"true" | "false"Replace the file at `path` if it already exists instead of generating a unique path.
filerequiredstring:binaryFile content to upload.
CreateFileJsonBodyprojectIdrequiredstring:uuidProject to create the file in.
pathrequiredstringRequested destination path within the project. If it already exists and `overwrite` is not set, a unique path is generated.
contentrequiredstringFile content encoded as UTF-8 text or base64.
encoding"utf8" | "base64"overwritebooleanReplace the file at `path` if it already exists instead of generating a unique path.
Responses
▸201File created
CreateFileResponsefilerequiredCreatedFile▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Project not found
ErrorResponsemessagerequiredstring▸409Project is suspended, or `overwrite` is set and the path is a directory
ErrorResponsemessagerequiredstring▸413File too large
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstringDelete a file
/filesParameters
projectIdqueryrequiredstring:uuidProject that contains the file.
pathqueryrequiredstringFile path within the project.
Responses
▸204File deleted
▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404File not found
ErrorResponsemessagerequiredstring▸409Project is suspended
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstringCopy a file between projects
Copies a source file into another project, using the source file path as the target path.
/files/copyRequest body
CopyFileBodysourceProjectIdrequiredstring:uuidProject that contains the source file.
targetProjectIdrequiredstring:uuidProject to copy the file into.
sourceFilePathrequiredstringFile path within the source project. The same normalized path is used in the target project.
Responses
▸201File copied
CopyFileResponsefilerequiredFileReference▸400Validation error
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404Project or file not found
ErrorResponsemessagerequiredstring▸409Project is suspended or target file already exists in the destination project
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstringDownload a file
Streams the raw content of a file from the project filesystem.
/files/downloadParameters
projectIdqueryrequiredstring:uuidProject that contains the file.
pathqueryrequiredstringFile path within the project.
Responses
▸200Raw file content
string:binary▸400Validation error or path is not a file
ErrorResponsemessagerequiredstring▸401Unauthorized
ErrorResponsemessagerequiredstring▸403Insufficient permissions
ErrorResponsemessagerequiredstring▸404File not found
ErrorResponsemessagerequiredstring▸409Project is suspended
ErrorResponsemessagerequiredstring▸429Rate limit exceeded
ErrorResponsemessagerequiredstring▸500Internal server error
ErrorResponsemessagerequiredstring