API paths
| Box | Boat |
|---|---|
/boxes | /sandboxes |
/boxes/{boxId} | /sandboxes/{sandboxId} |
/boxes/{boxId}/stop | /sandboxes/{sandboxId}/stop |
/boxes/{boxId}/resume | /sandboxes/{sandboxId}/resume |
/boxes/{boxId}/fork | /sandboxes/{sandboxId}/fork |
/boxes/{boxId}/prompt | /sandboxes/{sandboxId}/prompt |
/boxes/{boxId}/events | /sandboxes/{sandboxId}/events |
/boxes/{boxId}/conversations | /sandboxes/{sandboxId}/conversations |
/boxes/{boxId}/prompts/{promptId} | /sandboxes/{sandboxId}/prompts/{promptId} |
/boxes/{boxId}/files | /sandboxes/{sandboxId}/files |
/boxes/{boxId}/commands | /sandboxes/{sandboxId}/commands |
/boxes/{boxId}/commands/{processId} | /sandboxes/{sandboxId}/commands/{processId} |
/boxes/{boxId}/artifacts | /sandboxes/{sandboxId}/artifacts |
/boxes/{boxId}/steer | /sandboxes/{sandboxId}/steer |
/boxes/{boxId}/interrupt | /sandboxes/{sandboxId}/interrupt |
/boxes/{boxId}/desktop | /sandboxes/{sandboxId}/desktop |
/boxes/{boxId}/host | /sandboxes/{sandboxId}/host |
/boxes/{boxId}/sshkey | /sandboxes/{sandboxId}/sshkey |
/boxes/{boxId}/snapshots | /sandboxes/{sandboxId}/snapshots |
/boxes/{boxId}/snapshots/latest | /sandboxes/{sandboxId}/snapshots/latest |
/boxes/{boxId}/usage | /sandboxes/{sandboxId}/usage |
JSON keys
These keys change in requests and in responses.| Box | Boat |
|---|---|
activeBoxes | activeSandboxes |
box | sandbox |
boxCount | sandboxCount |
boxId | sandboxId |
boxIds | sandboxIds |
boxLifecycle | sandboxLifecycle |
boxPlanDollars | sandboxPlanDollars |
boxPlanKey | sandboxPlanKey |
boxType | sandboxType |
boxes | sandboxes |
maxActiveBoxes | maxActiveSandboxes |
passBoxCredentials | passSandboxCredentials |
queuedBoxes | queuedSandboxes |
sourceBoxId | sourceSandboxId |
OpenAPI schema and SDK type names
| Box | Boat |
|---|---|
Box | Sandbox |
BoxActionResponse | SandboxActionResponse |
BoxBearerAuth | BoatBearerAuth |
BoxEnvironment | SandboxEnvironment |
BoxEnvironmentListResponse | SandboxEnvironmentListResponse |
BoxEnvironmentResponse | SandboxEnvironmentResponse |
BoxEnvironmentVersionSummary | SandboxEnvironmentVersionSummary |
BoxEvent | SandboxEvent |
BoxId | SandboxId |
BoxInfoResponse | SandboxInfoResponse |
BoxListResponse | SandboxListResponse |
BoxUsageResponse | SandboxUsageResponse |
CreateBoxEnvironmentRequest | CreateSandboxEnvironmentRequest |
CreateBoxRequest | CreateSandboxRequest |
CreateBoxResponse | CreateSandboxResponse |
UpdateBoxEnvironmentRequest | UpdateSandboxEnvironmentRequest |
UpdateBoxRequest | UpdateSandboxRequest |
UpgradeBoxEnvironmentRequest | UpgradeSandboxEnvironmentRequest |
UpgradeBoxEnvironmentResponse | UpgradeSandboxEnvironmentResponse |
OpenAPI operation IDs and SDK method names
| Box | Boat |
|---|---|
boxes | sandboxes |
deleteBox | deleteSandbox |
deliverBoxLifecycleEvent | deliverSandboxLifecycleEvent |
getLatestBoxSnapshot | getLatestSandboxSnapshot |
listBoxSnapshots | listSandboxSnapshots |
Envelope type values
| Box | Boat |
|---|---|
box.create | sandbox.create |
box.created | sandbox.created |
box.deleting | sandbox.deleting |
box.error | sandbox.error |
box.fork | sandbox.fork |
box.forking | sandbox.forking |
box.info | sandbox.info |
box.list | sandbox.list |
box.resume | sandbox.resume |
box.resuming | sandbox.resuming |
box.stopping | sandbox.stopping |
box.updated | sandbox.updated |
box.usage | sandbox.usage |
Error code values
| Box | Boat |
|---|---|
box_billing_not_configured | sandbox_billing_not_configured |
box_busy | sandbox_busy |
box_deletion_conflict | sandbox_deletion_conflict |
box_direct_failed | sandbox_direct_failed |
box_email_auth_not_configured | sandbox_email_auth_not_configured |
box_not_archivable | sandbox_not_archivable |
box_not_found | sandbox_not_found |
box_not_promptable | sandbox_not_promptable |
box_not_snapshotable | sandbox_not_snapshotable |
box_purge_pending | sandbox_purge_pending |
box_recent_snapshot_required | sandbox_recent_snapshot_required |
box_required | sandbox_required |
box_restoring | sandbox_restoring |
box_resuming | sandbox_resuming |
box_running_stop_first | sandbox_running_stop_first |
box_securing | sandbox_securing |
box_starting | sandbox_starting |
box_stopping | sandbox_stopping |
Webhook events
| Box | Boat |
|---|---|
box.archived | sandbox.archived |
box.degraded | sandbox.degraded |
box.error | sandbox.error |
box.hydrated | sandbox.hydrated |
box.ready | sandbox.ready |
box.recovered | sandbox.recovered |
CLI environment variables
| Box | Boat |
|---|---|
BOX_AMSTERDAM_API_URL | BOAT_AMSTERDAM_API_URL |
BOX_AMSTERDAM_CURRENT_ID | BOAT_AMSTERDAM_CURRENT_ID |
BOX_API_URL | BOAT_API_URL |
BOX_CURRENT_CONVO | BOAT_CURRENT_CONVO |
BOX_CURRENT_CONVO_FILE | BOAT_CURRENT_CONVO_FILE |
BOX_CURRENT_ID | BOAT_CURRENT_ID |
BOX_CURRENT_ID_FILE | BOAT_CURRENT_ID_FILE |
BOX_DASHBOARD_URL | BOAT_DASHBOARD_URL |
BOX_DEV_API_URL | BOAT_DEV_API_URL |
BOX_DEV_CURRENT_CONVO | BOAT_DEV_CURRENT_CONVO |
BOX_DEV_CURRENT_ID | BOAT_DEV_CURRENT_ID |
BOX_ID | BOAT_ID |
BOX_ORG | BOAT_ORG |
BOX_SCP_ARCHIVE | BOAT_SCP_ARCHIVE |
BOX_SCP_LEGACY | BOAT_SCP_LEGACY |
BOX_SCP_RSYNC | BOAT_SCP_RSYNC |
BOX_SSH_TRACE | BOAT_SSH_TRACE |
BOX_STAGING_API_URL | BOAT_STAGING_API_URL |
BOX_STAGING_CURRENT_CONVO | BOAT_STAGING_CURRENT_CONVO |
BOX_STAGING_CURRENT_ID | BOAT_STAGING_CURRENT_ID |
In-sandbox environment variables
Boat exports both spellings inside each sandbox.| Box | Boat |
|---|---|
BOX_ID | BOAT_ID |
BOX_CURRENT_ID | BOAT_CURRENT_ID |
BOX_DEV_CURRENT_ID | BOAT_DEV_CURRENT_ID |
BOX_CLI_API_URL | BOAT_CLI_API_URL |
BOX_CLI_CHANNEL | BOAT_CLI_CHANNEL |
BOX_CLI_MODE | BOAT_CLI_MODE |
HTTP headers and query parameters
| Box | Boat |
|---|---|
X-Box-Org | X-Boat-Org |
?box_api_url= (dashboard links) | ?boat_api_url= |
?box_bootstrap= (post-login links) | ?boat_bootstrap= |
?box_token= (deprecated before the rename) | ?boat_token= |
?tab=boxes (dashboard) | ?tab=sandboxes |
CLI flags
| Box | Boat |
|---|---|
boat api-key create --box <id> | boat api-key create --sandbox <id> |
Files and directories
| Box | Boat |
|---|---|
.boxignore | .boatignore |
~/.config/ascii/box/config.json | ~/.config/ascii/boat/config.json |
~/.config/ascii/box-dev/config.json | ~/.config/ascii/boat-dev/config.json |
~/.ascii/bin/box | ~/.ascii/bin/boat |
agent skill skills/box/SKILL.md | skills/boat/SKILL.md |