> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Sandbox API

> Create isolated sessions, run commands, and manage files.

Create isolated sessions, run commands, and manage files.

Run commands synchronously, stream their output, or start background commands. Use the session ID to access files, command results, and the terminal.

Use the [file endpoints](/docs/cloud/rest/api-reference/sandbox-files/list-sandbox-files) and [terminal endpoint](/docs/cloud/rest/api-reference/sandbox-terminal/open-sandbox-terminal) to work in the same session. Health, readiness, and heartbeat endpoints support session monitoring. See [WebSocket connections](https://veryfront.com/docs/cloud/rest/protocols#websocket-connections) for terminal WebSocket access.

[Sandbox Sessions](#sandbox-sessions) · [Sandbox Commands](#sandbox-commands) · [Sandbox Files](#sandbox-files) · [Sandbox Terminal](#sandbox-terminal) · [Sandbox Health](#sandbox-health)

## Sandbox Sessions

Create, read, update, or delete sandbox sessions.

| Endpoint | Methods | Description |
| - | - | - |
| `/sandbox-sessions` | [GET](/docs/cloud/rest/api-reference/sandbox-sessions/list-sandbox-sessions), [POST](/docs/cloud/rest/api-reference/sandbox-sessions/create-sandbox-session) | List sandbox sessions; Create sandbox session |
| `/sandbox-sessions/{session_id}` | [GET](/docs/cloud/rest/api-reference/sandbox-sessions/get-sandbox-session), [PATCH](/docs/cloud/rest/api-reference/sandbox-sessions/update-sandbox-session-lifetime), [DELETE](/docs/cloud/rest/api-reference/sandbox-sessions/delete-sandbox-session) | Get sandbox session; Update sandbox session lifetime; Delete sandbox session |
| `/sandbox-sessions/{session_id}/environment` | [GET](/docs/cloud/rest/api-reference/sandbox-sessions/get-sandbox-environment-snapshot) | Get sandbox environment snapshot |

## Sandbox Commands

Run commands and inspect command output.

| Endpoint | Methods | Description |
| - | - | - |
| `/sandbox-sessions/{session_id}/commands` | [GET](/docs/cloud/rest/api-reference/sandbox-commands/list-sandbox-background-commands), [POST](/docs/cloud/rest/api-reference/sandbox-commands/start-sandbox-background-command) | List sandbox background commands; Start sandbox background command |
| `/sandbox-sessions/{session_id}/commands/{command_id}` | [GET](/docs/cloud/rest/api-reference/sandbox-commands/get-sandbox-background-command) | Get sandbox background command |
| `/sandbox-sessions/{session_id}/commands/{command_id}/output` | [GET](/docs/cloud/rest/api-reference/sandbox-commands/get-sandbox-background-command-output) | Get sandbox background command output |
| `/sandbox-sessions/{session_id}/commands/{command_id}/cancel` | [POST](/docs/cloud/rest/api-reference/sandbox-commands/cancel-sandbox-background-command) | Cancel sandbox background command |
| `/sandbox-sessions/{session_id}/commands/run` | [POST](/docs/cloud/rest/api-reference/sandbox-commands/run-sandbox-command) | Run sandbox command |
| `/sandbox-sessions/{session_id}/commands/stream` | [POST](/docs/cloud/rest/api-reference/sandbox-commands/stream-sandbox-command) | Stream sandbox command |

## Sandbox Files

List, read, or write sandbox files.

| Endpoint | Methods | Description |
| - | - | - |
| `/sandbox-sessions/{session_id}/files` | [GET](/docs/cloud/rest/api-reference/sandbox-files/list-sandbox-files), [POST](/docs/cloud/rest/api-reference/sandbox-files/write-sandbox-files) | List sandbox files; Write sandbox files |
| `/sandbox-sessions/{session_id}/file` | [GET](/docs/cloud/rest/api-reference/sandbox-files/read-sandbox-file) | Read sandbox file |

## Sandbox Terminal

Open a sandbox terminal.

| Endpoint | Methods | Description |
| - | - | - |
| `/sandbox-sessions/{session_id}/terminal` | [GET](/docs/cloud/rest/api-reference/sandbox-terminal/open-sandbox-terminal) | Open sandbox terminal |

## Sandbox Health

Check sandbox health, readiness, and heartbeat state.

| Endpoint | Methods | Description |
| - | - | - |
| `/sandbox-sessions/{session_id}/healthz` | [GET](/docs/cloud/rest/api-reference/sandbox-health/check-sandbox-health) | Check sandbox health |
| `/sandbox-sessions/{session_id}/readyz` | [GET](/docs/cloud/rest/api-reference/sandbox-health/check-sandbox-readiness) | Check sandbox readiness |
| `/sandbox-sessions/{session_id}/heartbeat` | [POST](/docs/cloud/rest/api-reference/sandbox-health/update-sandbox-activity) | Update sandbox activity |

[Back to REST API reference](/docs/cloud/rest)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.