Skip to main content
Sign In

HTTP API

Sandbox Agent HTTP endpoints, request schemas, and responses.

Use the Sandbox Agent HTTP API from any language. The server listens on port 2468 by default.

Download the OpenAPI specification.

Browse schemas and authentication schemes.

v1

All v1 endpoints.

MethodEndpointReference
GET/v1/acpget_v1_acp_servers
GET/v1/acp/{server_id}get_v1_acp
POST/v1/acp/{server_id}post_v1_acp
DELETE/v1/acp/{server_id}delete_v1_acp
GET/v1/agentsget_v1_agents
GET/v1/agents/{agent}get_v1_agent
POST/v1/agents/{agent}/installpost_v1_agent_install
GET/v1/config/mcpget_v1_config_mcp
PUT/v1/config/mcpput_v1_config_mcp
DELETE/v1/config/mcpdelete_v1_config_mcp
GET/v1/config/skillsget_v1_config_skills
PUT/v1/config/skillsput_v1_config_skills
DELETE/v1/config/skillsdelete_v1_config_skills
GET/v1/desktop/clipboardRead the desktop clipboard.
POST/v1/desktop/clipboardWrite to the desktop clipboard.
GET/v1/desktop/display/infoGet desktop display information.
POST/v1/desktop/keyboard/downPress and hold a desktop keyboard key.
POST/v1/desktop/keyboard/pressPress a desktop keyboard shortcut.
POST/v1/desktop/keyboard/typeType desktop keyboard text.
POST/v1/desktop/keyboard/upRelease a desktop keyboard key.
POST/v1/desktop/launchLaunch a desktop application.
POST/v1/desktop/mouse/clickClick on the desktop.
POST/v1/desktop/mouse/downPress and hold a desktop mouse button.
POST/v1/desktop/mouse/dragDrag the desktop mouse.
POST/v1/desktop/mouse/moveMove the desktop mouse.
GET/v1/desktop/mouse/positionGet the current desktop mouse position.
POST/v1/desktop/mouse/scrollScroll the desktop mouse wheel.
POST/v1/desktop/mouse/upRelease a desktop mouse button.
POST/v1/desktop/openOpen a file or URL with the default handler.
POST/v1/desktop/recording/startStart desktop recording.
POST/v1/desktop/recording/stopStop desktop recording.
GET/v1/desktop/recordingsList desktop recordings.
GET/v1/desktop/recordings/{id}Get desktop recording metadata.
DELETE/v1/desktop/recordings/{id}Delete a desktop recording.
GET/v1/desktop/recordings/{id}/downloadDownload a desktop recording.
GET/v1/desktop/screenshotCapture a full desktop screenshot.
GET/v1/desktop/screenshot/regionCapture a desktop screenshot region.
POST/v1/desktop/startStart the private desktop runtime.
GET/v1/desktop/statusGet desktop runtime status.
POST/v1/desktop/stopStop the private desktop runtime.
GET/v1/desktop/stream/signalingOpen a desktop WebRTC signaling session.
POST/v1/desktop/stream/startStart desktop streaming.
GET/v1/desktop/stream/statusGet desktop stream status.
POST/v1/desktop/stream/stopStop desktop streaming.
GET/v1/desktop/windowsList visible desktop windows.
GET/v1/desktop/windows/focusedGet the currently focused desktop window.
POST/v1/desktop/windows/{id}/focusFocus a desktop window.
POST/v1/desktop/windows/{id}/moveMove a desktop window.
POST/v1/desktop/windows/{id}/resizeResize a desktop window.
GET/v1/fs/entriesget_v1_fs_entries
DELETE/v1/fs/entrydelete_v1_fs_entry
GET/v1/fs/fileget_v1_fs_file
PUT/v1/fs/fileput_v1_fs_file
POST/v1/fs/mkdirpost_v1_fs_mkdir
POST/v1/fs/movepost_v1_fs_move
GET/v1/fs/statget_v1_fs_stat
POST/v1/fs/upload-batchpost_v1_fs_upload_batch
GET/v1/healthget_v1_health
GET/v1/processesList all managed processes.
POST/v1/processesCreate a long-lived managed process.
GET/v1/processes/configGet process runtime configuration.
POST/v1/processes/configUpdate process runtime configuration.
POST/v1/processes/runRun a one-shot command.
GET/v1/processes/{id}Get a single process by ID.
DELETE/v1/processes/{id}Delete a process record.
POST/v1/processes/{id}/inputWrite input to a process.
POST/v1/processes/{id}/killSend SIGKILL to a process.
GET/v1/processes/{id}/logsFetch process logs.
POST/v1/processes/{id}/stopSend SIGTERM to a process.
POST/v1/processes/{id}/terminal/resizeResize a process terminal.
GET/v1/processes/{id}/terminal/wsOpen an interactive WebSocket terminal session.
Edit this page