Desktop File
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
PATCH | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
POST | |
POST | |
GET | |
POST |
List all desktop file system
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
Adds per-folder, versioned markdown instructions describing the contents of a folder.
Required API key scopes
file_system:readQuery parameters
- limitinteger
- offsetinteger
- searchstring
Response
Example request
GET /api /projects /:project_id /desktop_file_systemExample response
Status 200
Create desktop file system
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
Adds per-folder, versioned markdown instructions describing the contents of a folder.
Required API key scopes
file_system:writeRequest parameters
- pathstring
- typestring
- refstringnull
- hrefstringnull
- meta
- shortcutbooleannull
Response
Example request
POST /api /projects /:project_id /desktop_file_systemExample response
Status 201
Retrieve desktop file system
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
Adds per-folder, versioned markdown instructions describing the contents of a folder.
Required API key scopes
file_system:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /desktop_file_system /:idExample response
Status 200
Update desktop file system
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
Adds per-folder, versioned markdown instructions describing the contents of a folder.
Required API key scopes
file_system:writePath parameters
- idstring
Request parameters
- pathstring
- typestring
- refstringnull
- hrefstringnull
- meta
- shortcutbooleannull
Response
Example request
PATCH /api /projects /:project_id /desktop_file_system /:idExample response
Status 200
Delete desktop file system
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
Adds per-folder, versioned markdown instructions describing the contents of a folder.
Required API key scopes
file_system:writePath parameters
- idstring
Example request
DELETE /api /projects /:project_id /desktop_file_system /:idExample response
Status 204 No response body
Update desktop file system canvas
Publish a new version of a freeform canvas's React source.
Merges into the dashboard row's meta (never replaces it), so existing
keys like channelId/templateId survive. Appends a full-file version
snapshot and points currentVersionId at it — the server-side mirror of
the app's dashboardsService.saveFreeform.
Required API key scopes
file_system:writePath parameters
- idstring
Request parameters
- codestring
- promptstring
- namestring
Response
Example request
PATCH /api /projects /:project_id /desktop_file_system /:id /canvasExample response
Status 200
Retrieve desktop file system context generation
Return the Task currently generating this folder's CONTEXT.md, or null if none.
Required API key scopes
file_system:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /desktop_file_system /:id /context_generationExample response
Status 200
Create desktop file system count
Get count of all files in a folder.
Required API key scopes
file_system:readPath parameters
- idstring
Request parameters
- pathstring
- typestring
- refstringnull
- hrefstringnull
- meta
- shortcutbooleannull
Example request
POST /api /projects /:project_id /desktop_file_system /:id /countExample response
Status 200 No response body
Retrieve desktop file system instructions
Return the latest non-deleted instructions for this folder.
Required API key scopes
file_system:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /desktop_file_system /:id /instructionsExample response
Status 200
Update desktop file system instructions
Publish a new version of the folder's instructions.
Required API key scopes
file_system:writePath parameters
- idstring
Request parameters
- contentstring
- base_versioninteger
Response
Example request
PATCH /api /projects /:project_id /desktop_file_system /:id /instructionsExample response
Status 200
Delete desktop file system instructions
Soft-delete every version of this folder's instructions.
Required API key scopes
file_system:writePath parameters
- idstring
Example request
DELETE /api /projects /:project_id /desktop_file_system /:id /instructionsExample response
Status 204 No response body
List all desktop file system instructions versions
List the version history for this folder's instructions, newest first.
Required API key scopes
file_system:readPath parameters
- idstring
Query parameters
- limitinteger
- offsetinteger
- searchstring
Response
Example request
GET /api /projects /:project_id /desktop_file_system /:id /instructions /versionsExample response
Status 200
Create desktop file system link
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
Adds per-folder, versioned markdown instructions describing the contents of a folder.
Required API key scopes
file_system:writePath parameters
- idstring
Request parameters
- pathstring
- typestring
- refstringnull
- hrefstringnull
- meta
- shortcutbooleannull
Example request
POST /api /projects /:project_id /desktop_file_system /:id /linkExample response
Status 200 No response body
Create desktop file system move
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
Adds per-folder, versioned markdown instructions describing the contents of a folder.
Required API key scopes
file_system:writePath parameters
- idstring
Request parameters
- pathstring
- typestring
- refstringnull
- hrefstringnull
- meta
- shortcutbooleannull
Example request
POST /api /projects /:project_id /desktop_file_system /:id /moveExample response
Status 200 No response body
Create desktop file system count by path
Get count of all files in a folder.
Required API key scopes
file_system:readRequest parameters
- pathstring
- typestring
- refstringnull
- hrefstringnull
- meta
- shortcutbooleannull
Example request
POST /api /projects /:project_id /desktop_file_system /count_by_pathExample response
Status 200 No response body
Retrieve desktop file system log view
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
Adds per-folder, versioned markdown instructions describing the contents of a folder.
Required API key scopes
file_system:writeExample request
GET /api /projects /:project_id /desktop_file_system /log_viewExample response
Status 200 No response body
Create desktop file system log view
The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
Adds per-folder, versioned markdown instructions describing the contents of a folder.
Required API key scopes
file_system:writeRequest parameters
- pathstring
- typestring
- refstringnull
- hrefstringnull
- meta
- shortcutbooleannull
Example request
POST /api /projects /:project_id /desktop_file_system /log_view