Create an instance
Start with a copyable request.
Run commands
Execute code on your sandbox.
Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Create, inspect, and manage persistent sandboxes.
| Method | Path | Returns |
|---|---|---|
POST | /v1/instances | 201 with the full instance object |
GET | /v1/instances | 200 { "data": [...] }, newest first, each the full instance object |
GET | /v1/instances/{id} | 200 with the full instance object |
PATCH | /v1/instances/{id} | 200 with the full instance object |
DELETE | /v1/instances/{id} | 200 { "id": "...", "deleted": true } |
POST | /v1/instances/{id}/stop | 200 { id, status } ack |
POST | /v1/instances/{id}/start | 200 { id, status } ack |
POST | /v1/instances/{id}/restart | 200 { id, status } ack |
POST | /v1/instances/{id}/update | 200 { id, status, image_ref, image_digest, template_revision } ack |
POST | /v1/instances/{id}/resize | 200 { id, status, resources } ack |
POST | /v1/instances/{id}/fork | 201 with the new instance’s full object |
GET | /v1/instances/{id}/backups | 200 { "data": [...] }, newest first, each a backup record |
POST | /v1/instances/{id}/backups | 201 with the backup record |
POST | /v1/instances/{id}/restore | 200 { id, status } ack |