File System
/filesList files and directories in the specified path. Use the optional depth parameter to list recursively: depth=1 (default) lists the directory's entries, depth=2 also includes their children, and so on.
Query Parameters
Directory path to list (defaults to working directory)
How many levels deep to list (default: 1, must be >= 1)
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/files"[ { "group": "string", "isDir": true, "modTime": "string", "mode": "string", "modifiedAt": "string", "name": "string", "owner": "string", "path": "string", "permissions": "string", "size": 0 }]/filesDelete a file or directory at the specified path
Query Parameters
File or directory path to delete
Enable recursive deletion for directories
Response Body
*/*
*/*
*/*
curl -X DELETE "https://example.com/files?path=string"/files/bulk-downloadDownload multiple files by providing their paths. Successful files are returned as multipart parts named file. Per-file failures are returned as multipart parts named error with JSON payloads shaped like ErrorResponse.
Request Body
application/json
Paths of files to download
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
multipart/form-data
multipart/form-data
multipart/form-data
multipart/form-data
multipart/form-data
curl -X POST "https://example.com/files/bulk-download" \ -H "Content-Type: application/json" \ -d '{ "paths": [ "string" ] }'{ "property1": null, "property2": null}curl -X POST "https://example.com/files/bulk-upload"/files/downloadDownload a file by providing its path
Query Parameters
File path to download
Response Body
application/octet-stream
application/octet-stream
application/octet-stream
application/octet-stream
curl -X GET "https://example.com/files/download?path=string"/files/findSearch for text pattern within files in a directory
Query Parameters
Directory path to search in
Text pattern to search for
Response Body
application/json
application/json
curl -X GET "https://example.com/files/find?path=string&pattern=string"[ { "content": "string", "file": "string", "line": 0 }]/files/folderCreate a folder with the specified path and optional permissions
Query Parameters
Folder path to create
Octal permission mode (default: 0755)
Response Body
*/*
curl -X POST "https://example.com/files/folder?path=string&mode=string"/files/infoGet detailed information about a file or directory
Query Parameters
File or directory path
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/files/info?path=string"{ "group": "string", "isDir": true, "modTime": "string", "mode": "string", "modifiedAt": "string", "name": "string", "owner": "string", "path": "string", "permissions": "string", "size": 0}/files/moveMove or rename a file or directory from source to destination
Query Parameters
Source file or directory path
Destination file or directory path
Response Body
*/*
*/*
*/*
*/*
curl -X POST "https://example.com/files/move?source=string&destination=string"/files/permissionsSet file permissions, ownership, and group for a file or directory
Query Parameters
File or directory path
Owner (username or UID)
Group (group name or GID)
File mode in octal format (e.g., 0755)
Response Body
*/*
*/*
*/*
curl -X POST "https://example.com/files/permissions?path=string"/files/replaceReplace text pattern with new value in multiple files
Request Body
application/json
Replace request
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/files/replace" \ -H "Content-Type: application/json" \ -d '{ "files": [ "string" ], "newValue": "string", "pattern": "string" }'[ { "error": "string", "file": "string", "success": true }]/files/searchSearch for files matching a specific pattern in a directory
Query Parameters
Directory path to search in
File pattern to match (e.g., *.txt, *.go)
Response Body
application/json
application/json
curl -X GET "https://example.com/files/search?path=string&pattern=string"{ "files": [ "string" ]}/files/upload-v2Upload a file to the specified path. Accepts either multipart/form-data (field "file") or a raw request body (e.g. application/octet-stream). Parent directories are created if missing; an existing file is overwritten.
Query Parameters
Destination path for the uploaded file
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/files/upload-v2?path=string"{ "name": "string", "path": "string", "type": "string"}