E2B

E2B-compatible API

Compatible with the official E2B API. Point your E2B SDK's api_url at the address below and set domain to praxisusercontent.com; change nothing else.

Base URL

Loading…

Get started

Loading…

Control plane and data plane

  • Control plane: the endpoints listed on this page (create, list, pause, connect, kill …) live at the base URL above and authenticate with your API key (the X-API-Key header; the official SDK sends it for you).
  • Data plane: running commands and reading files inside a sandbox goes straight to <port>-<sandbox ID>.praxisusercontent.com with the access token returned when the sandbox was created — so besides api_url the SDK also needs domain set to praxisusercontent.com.

Or leave the code alone and set environment variables:

Loading…

Endpoints

MethodPathDescriptionSupport
POST/sandboxesCreate a sandbox● Supported
GET/sandboxesList running sandboxes● Supported
GET/sandboxes/{sandboxID}Get a sandbox● Supported
GET/sandboxes/{sandboxID}/metricsGet sandbox metrics● Supported
POST/sandboxes/{sandboxID}/timeoutSet sandbox timeout● Supported
POST/sandboxes/{sandboxID}/pausePause a sandbox● Supported
POST/sandboxes/{sandboxID}/connectConnect to a sandbox● Supported
DELETE/sandboxes/{sandboxID}Kill a sandbox● Supported
POST/v2/sandboxesCreate a sandbox (v2)● Supported
GET/v2/sandboxesList sandboxes (v2)● Supported
POST/v2/sandboxes/{sandboxID}/connectConnect to a sandbox (v2)● Supported
GET/templatesList templates● Supported
GET/v2/templatesList templates (v2)● Supported
POST/volumesCreate team volume● Supported
GET/volumesList team volumes● Supported
GET/volumes/{volumeID}Team volume● Supported
DELETE/volumes/{volumeID}Delete team volume● Supported
POST/sandboxes/{sandboxID}/forkFork a sandbox● Supported
POST/sandboxes/{sandboxID}/snapshotsCreate a snapshot● Supported
GET/snapshotsList snapshots● Supported
DELETE/templates/{templateID}Delete a snapshot● Supported
PUT/sandboxes/{sandboxID}/networkUpdate sandbox network● Supported
GET/v2/sandboxes/{sandboxID}/logsGet sandbox logs● Supported

Differences from E2B

  • Create a sandbox:Deprecated: the latest official SDK uses v2. The platform does not provide E2B's default base template yet: Sandbox.create() without a template returns 404, so name a template explicitly (see List templates for what is available).
  • List running sandboxes:Deprecated: the latest official SDK uses v2.
  • Connect to a sandbox:Deprecated: the latest official SDK uses v2.
  • List templates:Deprecated: the latest official SDK uses v2.

For authoritative parameter definitions, see the official E2B documentation.

Errors follow the E2B format, see errors; quotas and response headers are covered in rate limits.

Export

On this page