Skip to content

Computers API

Computer lifecycle, process, filesystem, workspace, and artifact endpoints.

All paths address a user-owned Desktop by desktopId.

MethodPathRequestResponse
GET/api/desktops/{desktopId}/computerComputerEnvelope
POST/api/desktops/{desktopId}/computer/startComputerEnvelope
POST/api/desktops/{desktopId}/computer/pauseComputerEnvelope
DELETE/api/desktops/{desktopId}/computerComputerEnvelope
GET/api/desktops/{desktopId}/computer/workspaceWorkspaceStatus
POST/api/desktops/{desktopId}/computer/process/execProcessExecRequestProcessExecResult
POST/api/desktops/{desktopId}/computer/fs/globFileGlobRequestFileGlobResult
POST/api/desktops/{desktopId}/computer/fs/readFileReadRequestFileReadResult
POST/api/desktops/{desktopId}/computer/fs/writeFileWriteRequestFileWriteResult
DELETE/api/desktops/{desktopId}/computer/fs/deleteFileDeleteRequest{ ok: true }
POST/api/desktops/{desktopId}/computer/fs/moveFileMoveRequestFileMoveResult
POST/api/desktops/{desktopId}/computer/fs/unzipFileUnzipRequestFileUnzipResult
POST/api/desktops/{desktopId}/computer/fs/uploadbinary body + queryFileUploadResult
GET/api/desktops/{desktopId}/computer/fs/download?filePath={path}query parameterBinary file
GET/api/desktops/{desktopId}/computer/fs/media?filePath={path}query parameterBinary media
GET/api/desktops/{desktopId}/computer/artifactsArtifactList
POST/api/desktops/{desktopId}/computer/artifacts/resolveArtifactResolveRequestArtifactEnvelope
GET/api/desktops/{desktopId}/computer/artifacts/{sessionId}/{artifactId}path parametersBinary artifact
GET /api/desktops/{desktopId}/computer
Terminal window
curl https://app.dexto.ai/api/desktops/$DESKTOP_ID/computer \
-H "Authorization: Bearer $DEXTO_API_KEY"

The start, pause, and delete endpoints return the same ComputerEnvelope after the lifecycle operation.

Response fieldJSON typeRequiredDescription
computer.desktopIdstringYesOwned Desktop identifier
computer.provider"e2b"YesManaged computer provider
computer.statusstringYesCurrent lifecycle state
computer.providerAttachmentIdstring | nullYesProvider runtime identifier
computer.operationobjectYesidle or in-progress update
computer.createdAt / updatedAtstring | nullYesISO-8601 lifecycle timestamps
POST /api/desktops/{desktopId}/computer/process/exec
Request fieldJSON typeRequiredDescription
commandstringYesShell command
cwdstringNoWorking directory; /workspace by default
run_in_backgroundbooleanNoReturn after starting the process
Terminal window
curl https://app.dexto.ai/api/desktops/$DESKTOP_ID/computer/process/exec \
-H "Authorization: Bearer $DEXTO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"command":"npm test","cwd":"/workspace"}'
POST /api/desktops/{desktopId}/computer/fs/read
Terminal window
curl https://app.dexto.ai/api/desktops/$DESKTOP_ID/computer/fs/read \
-H "Authorization: Bearer $DEXTO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"filePath":"/workspace/package.json"}'
Request fieldJSON typeRequiredDescription
filePathstringYesAbsolute workspace path
POST /api/desktops/{desktopId}/computer/fs/write
Terminal window
curl https://app.dexto.ai/api/desktops/$DESKTOP_ID/computer/fs/write \
-H "Authorization: Bearer $DEXTO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"filePath":"/workspace/notes.md","content":"# Notes\n","createDirectories":true}'
Request fieldJSON typeRequiredDescription
filePathstringYesAbsolute workspace path
contentstringYesUTF-8 text
createDirectoriesbooleanNoCreate missing parent directories

Terminal sockets and interactive browser-session state are dashboard session APIs, not part of the API-key REST surface.