Upload file
Upload a file to a workspace and push it to running computers.
destPath switches the endpoint to a second mode. That mode drops the file into one exact folder on one computer and records nothing. The two modes return different bodies. See Folder-targeted upload.
Request
Send amultipart/form-data request.
filename. The copy in object storage is keyed under a sanitised form of it.desktop_id of null. Association does not change where the file is pushed. Every running computer in the workspace receives it either way. Required when destPath is set./. When set, the file is placed at <destPath>/<file name> on the computer named by desktopId, and nothing else happens: no file record is written, no other computer receives it, and the response body is different. When omitted, the file is stored in the workspace and pushed to running computers.Response
WithoutdestPath, the whole stored row is returned under file.
id to the download and delete endpoints.desktopId you supplied, or null.application/octet-stream when the client sent none.upload for this endpoint.Example
Response
How the file reaches a computer
/root/Desktop on every computer that is running at the time of upload. Computers that are stopped, or created afterwards, do not receive it. Upload again to reach them. The push is best-effort and runs after the response is sent, so it does not affect the status you get back./root/Desktop rather than overwriting it.
Folder-targeted upload
SettingdestPath places the file at one exact path on one computer. The response is a different shape and no file record is created. The file does not appear in the list endpoint, and it cannot be downloaded or deleted through this API.
true when the file was placed on the computer.<destPath>/<file name>.Errors
Every error carries the shape{"error": "<message>"}.
Authorizations
API key authentication. Get your key at orgo.ai/workspaces
Body
File to upload (max 10MB)
Workspace ID. Required; omitting it is a 400.
Computer to associate the file with. Omitted, the file belongs to the workspace and is synced to every running computer in it. Required when you send destPath.
Absolute folder on the computer to place the file in. Sending it changes what the endpoint does: no file record is written, nothing is synced, and the bytes are pulled straight into that folder on the computer named by desktopId. Must start with /. Omitted, the file is stored against the workspace and synced to its running computers.
"/root/Desktop"
Response
File uploaded. destPath requests answer with the placement result instead of a file record.
- Option 1
- Option 2