HTTP API
Source:
sandbox-agent/docs/content/docs/api-reference/index.mdxCanonical URL: https://rivet.dev/sandbox-agent/docs/api-reference Description: 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
| Method | Endpoint | Reference |
|---|---|---|
| GET | /v1/acp |
get_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/agents |
get_v1_agents |
| GET | /v1/agents/{agent} |
get_v1_agent |
| POST | /v1/agents/{agent}/install |
post_v1_agent_install |
| GET | /v1/config/mcp |
get_v1_config_mcp |
| PUT | /v1/config/mcp |
put_v1_config_mcp |
| DELETE | /v1/config/mcp |
delete_v1_config_mcp |
| GET | /v1/config/skills |
get_v1_config_skills |
| PUT | /v1/config/skills |
put_v1_config_skills |
| DELETE | /v1/config/skills |
delete_v1_config_skills |
| GET | /v1/desktop/clipboard |
Read the desktop clipboard. |
| POST | /v1/desktop/clipboard |
Write to the desktop clipboard. |
| GET | /v1/desktop/display/info |
Get desktop display information. |
| POST | /v1/desktop/keyboard/down |
Press and hold a desktop keyboard key. |
| POST | /v1/desktop/keyboard/press |
Press a desktop keyboard shortcut. |
| POST | /v1/desktop/keyboard/type |
Type desktop keyboard text. |
| POST | /v1/desktop/keyboard/up |
Release a desktop keyboard key. |
| POST | /v1/desktop/launch |
Launch a desktop application. |
| POST | /v1/desktop/mouse/click |
Click on the desktop. |
| POST | /v1/desktop/mouse/down |
Press and hold a desktop mouse button. |
| POST | /v1/desktop/mouse/drag |
Drag the desktop mouse. |
| POST | /v1/desktop/mouse/move |
Move the desktop mouse. |
| GET | /v1/desktop/mouse/position |
Get the current desktop mouse position. |
| POST | /v1/desktop/mouse/scroll |
Scroll the desktop mouse wheel. |
| POST | /v1/desktop/mouse/up |
Release a desktop mouse button. |
| POST | /v1/desktop/open |
Open a file or URL with the default handler. |
| POST | /v1/desktop/recording/start |
Start desktop recording. |
| POST | /v1/desktop/recording/stop |
Stop desktop recording. |
| GET | /v1/desktop/recordings |
List 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}/download |
Download a desktop recording. |
| GET | /v1/desktop/screenshot |
Capture a full desktop screenshot. |
| GET | /v1/desktop/screenshot/region |
Capture a desktop screenshot region. |
| POST | /v1/desktop/start |
Start the private desktop runtime. |
| GET | /v1/desktop/status |
Get desktop runtime status. |
| POST | /v1/desktop/stop |
Stop the private desktop runtime. |
| GET | /v1/desktop/stream/signaling |
Open a desktop WebRTC signaling session. |
| POST | /v1/desktop/stream/start |
Start desktop streaming. |
| GET | /v1/desktop/stream/status |
Get desktop stream status. |
| POST | /v1/desktop/stream/stop |
Stop desktop streaming. |
| GET | /v1/desktop/windows |
List visible desktop windows. |
| GET | /v1/desktop/windows/focused |
Get the currently focused desktop window. |
| POST | /v1/desktop/windows/{id}/focus |
Focus a desktop window. |
| POST | /v1/desktop/windows/{id}/move |
Move a desktop window. |
| POST | /v1/desktop/windows/{id}/resize |
Resize a desktop window. |
| GET | /v1/fs/entries |
get_v1_fs_entries |
| DELETE | /v1/fs/entry |
delete_v1_fs_entry |
| GET | /v1/fs/file |
get_v1_fs_file |
| PUT | /v1/fs/file |
put_v1_fs_file |
| POST | /v1/fs/mkdir |
post_v1_fs_mkdir |
| POST | /v1/fs/move |
post_v1_fs_move |
| GET | /v1/fs/stat |
get_v1_fs_stat |
| POST | /v1/fs/upload-batch |
post_v1_fs_upload_batch |
| GET | /v1/health |
get_v1_health |
| GET | /v1/processes |
List all managed processes. |
| POST | /v1/processes |
Create a long-lived managed process. |
| GET | /v1/processes/config |
Get process runtime configuration. |
| POST | /v1/processes/config |
Update process runtime configuration. |
| POST | /v1/processes/run |
Run 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}/input |
Write input to a process. |
| POST | /v1/processes/{id}/kill |
Send SIGKILL to a process. |
| GET | /v1/processes/{id}/logs |
Fetch process logs. |
| POST | /v1/processes/{id}/stop |
Send SIGTERM to a process. |
| POST | /v1/processes/{id}/terminal/resize |
Resize a process terminal. |
| GET | /v1/processes/{id}/terminal/ws |
Open an interactive WebSocket terminal session. |