Skip to main content
GET
Workspace file endpoints use the storage API:
All paths are workspace-relative. Use / for the workspace root.

Endpoints

files:* and * also satisfy file scopes.

List Files

string
required
Workspace ID.
boolean
default:"false"
Include dotfiles and dot directories.

Storage Info

Root info returns drive-style storage usage:
Path info returns size and entry count:

Create Files And Folders

string
required
File or folder name. Names cannot contain path separators.
string
required
file or folder.

Upload Files

Uploads use multipart form data. The file field is required. The optional name field overrides the uploaded filename.
The default upload limit is 100 MB per request.

Download Files

string
required
Workspace-relative file ID, such as /src/README.md.
boolean
default:"false"
When true, return an attachment response. Otherwise, stream inline when possible.

Rename

Copy Or Move

Use file IDs from list responses.
operation can be copy or move. Batch copy and move accept up to 250 IDs.

Delete

Notes

  • Personal workspaces are only visible to the owner and organization admins.
  • When a workspace is over its storage quota, write operations return an error until usage is reduced or the org limit is updated.
  • Directory listing hides dotfiles unless showHidden=true.