Skip to main content
POST
Export file
Copies one file off a running computer into workspace storage and returns a download link. The computer sends the file straight to storage, so files up to 2 GB work. The file is recorded in the workspace with source set to export, so it also appears in the list endpoint.

Request

Send a JSON body.
string
required
Computer ID (UUID) to export from. Omitting it returns 400.
string
required
Absolute path to the file on the computer, such as /root/Desktop/results.txt or, on Windows, C:\Users\Public\results.txt. A relative path, or a Linux path on a Windows computer (or the reverse), returns 400. The file must be 2 GB or smaller.

Response

boolean
Always true.
object
The stored file record: id, project_id (the workspace), desktop_id, user_id, filename, storage_key, size_bytes (a decimal string), content_type, created_at and source (export). content_type is guessed from the file’s extension. If the record could not be saved, only filename, size_bytes, content_type and source are returned, and the link still works.
string
Signed download link. It expires after one hour. To get a fresh link later, pass file.id to the download endpoint.

Example

Response

Errors

Every error carries the shape {"error": "<message>"}. The scope-mismatch 403 adds code, key_workspace_id, and target_workspace_id. The checks below run in order, so the first one that fails is the status you get.

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Body

application/json
desktopId
string
required

Computer ID

path
string
required

Absolute path of the file on the computer, such as /root/Desktop/results.txt or C:\Users\Public\results.txt.

Response

The file was copied. url downloads it for one hour.

success
boolean
file
object
url
string

Signed download URL. Works for one hour.