Connect AI agents to E2B

Scalekit connector

The E2B connector lets your AI agent act in each user's E2B account. Each user connects their own E2B API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 38 tools.

Tools: 38
What they doRead · write · destructive: 20 · 13 · 520 read13 write5 destructive
Users sign in with: API key

Setup

Install the SDK
- Node.js
- Python
Terminal window
npm install @scalekit-sdk/node dotenv
Terminal window
pip install scalekit-sdk-python python-dotenv
Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the E2B connection
In AgentKit > Connections, create an E2B connection. The name you give it is the connection_name your code passes. See Configure connections.

Authorize a user and make your first call

Node.js
Python

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3
import { createInterface } from 'node:readline/promises'
4

5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
)
10
const actions = scalekit.actions
11

12
const connector = 'e2b'
13
const identifier = 'user_123'
14

15
// Generate an authorization link for the user
16
const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
17
console.log('Authorize E2B:', link)
18
const rl = createInterface({ input: process.stdin, output: process.stdout })
19
await rl.question('Press Enter after authorizing...')
20
rl.close()
21

22
// Make your first call
23
const result = await actions.executeTool({
24
  connector,
25
  identifier,
26
  toolName: 'e2b_list_events',
27
  toolInput: {},
28
})
29
console.log(result)

npx tsx quickstart.mts

1
import os
2
from scalekit import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "e2b"
14
identifier = "user_123"
15

16
# Generate an authorization link for the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier,
20
)
21
print("Authorize E2B:", link_response.link)
22
input("Press Enter after authorizing...")
23

24
# Make your first call
25
result = actions.execute_tool(
26
    tool_input={},
27
    tool_name="e2b_list_events",
28
    connection_name=connection_name,
29
    identifier=identifier,
30
)
31
print(result)

python quickstart.py

Each user opens the link once and enters their E2B credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

e2b_get_sandboxGet one E2B sandbox by its ID.Read-only
Get Sandbox
Get one E2B sandbox by its ID. Returns sandboxID, templateID, alias, state, startedAt, endAt, cpuCount, memoryMB, diskSizeMB, metadata, envdVersion, envdAccessToken, domain, allowInternetAccess, network, lifecycle (autoResume and onTimeout) and volumeMounts. Use this for a single sandbox's details. Use e2b_list_sandboxes to find sandbox IDs.
Inputs
sandbox_idstringrequired
ID of the sandbox to get, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
e2b_get_sandbox_logsGet the logs of an E2B sandbox, optionally filtered by level or text.Read-only
Get Sandbox Logs
Get the logs of an E2B sandbox, optionally filtered by level or text. Returns logs, an array of entries with timestamp, level, message and fields. Use this to debug what happened in a sandbox. Use e2b_list_sandbox_events for lifecycle events such as created or killed.
Inputs
sandbox_idstringrequired
ID of the sandbox to get logs for, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
cursorinteger
Timestamp in Unix milliseconds to start returning logs from. Example: 1760486400000
directionstring
Read direction from the cursor: forward (newer) or backward (older).one of forwardbackward
levelstring
Minimum log level to return, such as info, warn or error; lower levels are left out. Example: warn
limitinteger
Maximum number of log entries to return, from 0 to 1000. Defaults to 1000. Example: 200default 1000
searchstring
Case-sensitive text that the log message must contain. Example: Traceback
e2b_get_sandbox_metricsGet resource usage metrics over time for one E2B sandbox.Read-only
Get Sandbox Metrics
Get resource usage metrics over time for one E2B sandbox. Returns an array of samples with timestampUnix, cpuCount, cpuUsedPct, memUsed, memTotal, memCache, diskUsed and diskTotal (bytes). Use this for one sandbox's usage history. Use e2b_list_sandbox_metrics for the latest sample of several sandboxes at once.
Inputs
sandbox_idstringrequired
ID of the sandbox to get metrics for, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
endinteger
End of the time interval as a Unix timestamp in seconds. Leave empty to use E2B's default window. Example: 1760490000
startinteger
Start of the time interval as a Unix timestamp in seconds. Leave empty to use E2B's default window. Example: 1760486400
e2b_get_secretGet one E2B secret's metadata by its ID or name.Read-only
Get Secret
Get one E2B secret's metadata by its ID or name. Returns secretID, name, currentVersion, metadata, createdAt and updatedAt; the secret value is never returned. Use this to check a secret exists and see its current version. Use e2b_list_secrets to browse.
Inputs
secret_idstringrequired
The secret to get: its ID (sec_...) or its name. Example: stripe_api_key
e2b_get_team_max_metricGet the peak value of one E2B team metric in a time window.Read-only
Get Team Max Metric
Get the peak value of one E2B team metric in a time window. Returns timestampUnix and value of the maximum. Use this to check peak concurrency or start rate against plan limits. Use e2b_get_team_metrics for the full time series.
Inputs
metricstringrequired
Metric to get the maximum of: concurrent_sandboxes or sandbox_start_rate.one of concurrent_sandboxessandbox_start_rate
team_idstringrequired
Your team identifier, as its UUID or its public project ID (prj_...), shown in the E2B console. Example: prj_8f3k2l9q
endinteger
End of the time interval as a Unix timestamp in seconds. Leave empty to use E2B's default window. Example: 1760490000
startinteger
Start of the time interval as a Unix timestamp in seconds. Leave empty to use E2B's default window. Example: 1760486400
e2b_get_team_metricsGet your E2B team's sandbox usage over time.Read-only
Get Team Metrics
Get your E2B team's sandbox usage over time. Returns an array of samples with timestampUnix, concurrentSandboxes and sandboxStartRate. Use this to chart concurrency and start rate. Use e2b_get_team_max_metric for the peak value in a window.
Inputs
team_idstringrequired
Your team identifier, as its UUID or its public project ID (prj_...), shown in the E2B console. Example: prj_8f3k2l9q
endinteger
End of the time interval as a Unix timestamp in seconds. Leave empty to use E2B's default window. Example: 1760490000
startinteger
Start of the time interval as a Unix timestamp in seconds. Leave empty to use E2B's default window. Example: 1760486400
e2b_get_templateGet one E2B template and its builds.Read-only
Get Template
Get one E2B template and its builds. Returns templateID, names, aliases, public, createdAt, updatedAt, lastSpawnedAt, spawnCount and builds (each with buildID, status, cpuCount, memoryMB, diskSizeMB, envdVersion, createdAt and finishedAt). The cursor for more builds is in the X-Next-Token response header. Use this to see a template's build history and get a buildID. Use e2b_list_templates to find template IDs.
Inputs
template_idstringrequired
ID of the template to get, as returned by e2b_list_templates (templateID). Example: rki5dems9wqfm4r03t7g
limitinteger
Maximum number of builds to return per page, from 1 to 100. Defaults to 100. Example: 50default 100
next_tokenstring
Pagination cursor. Pass the value of the X-Next-Token response header from the previous page to get the next page; leave empty for the first page.
e2b_get_template_build_logsGet the logs of an E2B template build, paged by time.Read-only
Get Template Build Logs
Get the logs of an E2B template build, paged by time. Returns logs, an array of entries with timestamp, level, message and step. Use this to read a long build log. Use e2b_get_template_build_status to check whether the build succeeded.
Inputs
build_idstringrequired
ID of the template build, from the builds list in e2b_get_template (buildID). Example: a979a14b-bdcc-49e6-bc04-1189fc9fe7c2
template_idstringrequired
ID of the template to read logs for, as returned by e2b_list_templates (templateID). Example: rki5dems9wqfm4r03t7g
cursorinteger
Timestamp in Unix milliseconds to start returning logs from. Example: 1760486400000
directionstring
Read direction from the cursor: forward (newer) or backward (older).one of forwardbackward
levelstring
Minimum log level to return, such as info, warn or error. Example: warn
limitinteger
Maximum number of log entries to return, from 0 to 100. Defaults to 100. Example: 50default 100
sourcestring
Where to read logs from: temporary (live build logs) or persistent (stored logs).one of temporarypersistent
e2b_get_template_build_statusGet the status of an E2B template build, with its structured build logs.Read-only
Get Template Build Status
Get the status of an E2B template build, with its structured build logs. Returns templateID, buildID, status (building, waiting, ready, error or uploaded), reason (message and failed step on error) and logEntries (timestamp, level, message, step). Use this to check whether a build finished. Use e2b_get_template_build_logs to page through logs by time.
Inputs
build_idstringrequired
ID of the template build, from the builds list in e2b_get_template (buildID). Example: a979a14b-bdcc-49e6-bc04-1189fc9fe7c2
template_idstringrequired
ID of the template to check, as returned by e2b_list_templates (templateID). Example: rki5dems9wqfm4r03t7g
levelstring
Minimum log level to return, such as info, warn or error. Example: error
limitinteger
Maximum number of log entries to return, from 0 to 100. Defaults to 100. Example: 50default 100
logs_offsetinteger
Index of the first build log entry to return. Defaults to 0. Example: 100default 0
e2b_get_template_by_aliasLook up an E2B template by its alias to check that it exists.Read-only
Get Template by Alias
Look up an E2B template by its alias to check that it exists. Returns the template's templateID and whether it is public. Use this to turn a template name into its ID. Use e2b_get_template for full details once you have the ID.
Inputs
aliasstringrequired
The template alias (name) to look up. Example: code-interpreter-v1
e2b_get_volumeGet one E2B volume by its ID.Read-only
Get Volume
Get one E2B volume by its ID. Returns volumeID, name, token and domain. Use this to get a volume's access token and domain. Use e2b_list_volumes to find volume IDs.
Inputs
volume_idstringrequired
ID of the volume, as returned by e2b_list_volumes (volumeID). Example: 7d3f9a2e-1c4b-4e8a-9f60-2b5d8c1e4a73
e2b_list_eventsList lifecycle events for all sandboxes in the E2B project, such as created, paused, resumed and killed.Read-only
List Events
List lifecycle events for all sandboxes in the E2B project, such as created, paused, resumed and killed. Returns an array of events with id, type, timestamp, eventData, sandboxId, sandboxExecutionId, sandboxTemplateId, sandboxBuildId and sandboxTeamId. Use this for project-wide sandbox activity. Use e2b_list_sandbox_events for one sandbox.
Inputs
limitinteger
Maximum number of events to return, from 1 to 100. Defaults to 10. Example: 50default 10
offsetinteger
Number of events to skip, for paging through results. Defaults to 0. Example: 10default 0
order_ascboolean
Set to true to return events oldest first. Defaults to false (newest first).default false
typesarray
Only return events of these types. Known lifecycle types: sandbox.lifecycle.created, sandbox.lifecycle.killed, sandbox.lifecycle.paused, sandbox.lifecycle.resumed, sandbox.lifecycle.updated, sandbox.lifecycle.checkpointed. Example: ["sandbox.lifecycle.created", "sandbox.lifecycle.killed"]
e2b_list_sandbox_eventsList lifecycle events for one E2B sandbox, such as created, paused, resumed and killed.Read-only
List Sandbox Events
List lifecycle events for one E2B sandbox, such as created, paused, resumed and killed. Returns an array of events with id, type, timestamp, eventData, sandboxId, sandboxExecutionId, sandboxTemplateId, sandboxBuildId and sandboxTeamId. Use this for one sandbox's history. Use e2b_list_events for every sandbox in the project, and e2b_get_sandbox_logs for its log output.
Inputs
sandbox_idstringrequired
ID of the sandbox to list events for, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
limitinteger
Maximum number of events to return, from 1 to 100. Defaults to 10. Example: 50default 10
offsetinteger
Number of events to skip, for paging through results. Defaults to 0. Example: 10default 0
order_ascboolean
Set to true to return events oldest first. Defaults to false (newest first).default false
typesarray
Only return events of these types. Known lifecycle types: sandbox.lifecycle.created, sandbox.lifecycle.killed, sandbox.lifecycle.paused, sandbox.lifecycle.resumed, sandbox.lifecycle.updated, sandbox.lifecycle.checkpointed. Example: ["sandbox.lifecycle.created", "sandbox.lifecycle.killed"]
e2b_list_sandbox_metricsGet the latest resource usage metrics for several E2B sandboxes in one call.Read-only
List Sandbox Metrics
Get the latest resource usage metrics for several E2B sandboxes in one call. Returns sandboxes, an object keyed by sandbox ID whose values hold timestampUnix, cpuCount, cpuUsedPct, memUsed, memTotal, memCache, diskUsed and diskTotal. Use this to compare current usage across sandboxes. Use e2b_get_sandbox_metrics for one sandbox's history.
Inputs
sandbox_idsstringrequired
Comma-separated list of sandbox IDs to get metrics for. Example: iiny0783cype8gmoawzmx,ig6f1yt6idvxkxl562scj
e2b_list_sandboxesList the sandboxes in the E2B project, optionally filtered by state, metadata, template or start time.Read-only
List Sandboxes
List the sandboxes in the E2B project, optionally filtered by state, metadata, template or start time. Returns an array of sandboxes with sandboxID, templateID, alias, state (running or paused), startedAt, endAt, cpuCount, memoryMB, diskSizeMB, metadata and volumeMounts. The cursor for the next page is in the X-Next-Token response header. Use this to find sandboxes. Use e2b_get_sandbox for one sandbox's full details, including its network and lifecycle settings.
Inputs
limitinteger
Maximum number of sandboxes to return per page, from 1 to 100. Defaults to 100. Example: 50default 100
metadatastring
Filter by sandbox metadata, written as key=value pairs joined with &. Example: user=abc&app=prod
next_tokenstring
Pagination cursor. Pass the value of the X-Next-Token response header from the previous page to get the next page; leave empty for the first page.
orderstring
Sort direction by sandbox start time: desc (newest first, the default) or asc.one of ascdescdefault desc
started_afterstring
Only return sandboxes started at or after this time, as an RFC 3339 timestamp. Example: 2026-10-01T00:00:00Z
statestring
Filter by sandbox state: running, paused, or both as a comma-separated list. Example: running,paused
templatestring
Only return sandboxes created from this template ID or alias. Example: rki5dems9wqfm4r03t7g
e2b_list_secretsList the secrets stored in the E2B project.Read-only
List Secrets
List the secrets stored in the E2B project. Returns an array of secrets with secretID, name, currentVersion, metadata, createdAt and updatedAt; secret values are never returned. The cursor for the next page is in the X-Next-Token response header. Use this to find a secret. Use e2b_get_secret for one secret.
Inputs
limitinteger
Maximum number of secrets to return per page, from 1 to 100. Defaults to 100. Example: 50default 100
next_tokenstring
Pagination cursor. Pass the value of the X-Next-Token response header from the previous page to get the next page; leave empty for the first page.
e2b_list_snapshotsList the snapshots in the E2B project, optionally filtered by source sandbox or name.Read-only
List Snapshots
List the snapshots in the E2B project, optionally filtered by source sandbox or name. Returns an array of snapshots with snapshotID and names. The cursor for the next page is in the X-Next-Token response header. Use this to find a snapshot to start a sandbox from. Create one with e2b_create_snapshot.
Inputs
limitinteger
Maximum number of snapshots to return per page, from 1 to 100. Defaults to 100. Example: 50default 100
namestring
Filter by snapshot name or ID, optionally with a team or tag. Example: my-snapshot:v1
next_tokenstring
Pagination cursor. Pass the value of the X-Next-Token response header from the previous page to get the next page; leave empty for the first page.
sandbox_idstring
Only return snapshots taken from this sandbox. Example: iiny0783cype8gmoawzmx
e2b_list_template_tagsList the tags on an E2B template.Read-only
List Template Tags
List the tags on an E2B template. Returns an array of tags with tag, buildID and createdAt. Use this to see which build each tag points to. Use e2b_assign_template_tags to add tags.
Inputs
template_idstringrequired
ID of the template to list tags for, as returned by e2b_list_templates (templateID). Example: rki5dems9wqfm4r03t7g
e2b_list_templatesList the sandbox templates in the E2B project.Read-only
List Templates
List the sandbox templates in the E2B project. Returns an array of templates with templateID, buildID, names, aliases, public, buildStatus, cpuCount, memoryMB, diskSizeMB, envdVersion, createdAt, updatedAt, lastSpawnedAt, spawnCount and buildCount. The cursor for the next page is in the X-Next-Token response header. Use this to find a template ID for e2b_create_sandbox. Use e2b_get_template for a template's builds, or e2b_get_template_by_alias to look one up by name.
Inputs
limitinteger
Maximum number of templates to return per page, from 1 to 100. Defaults to 100. Example: 50default 100
next_tokenstring
Pagination cursor. Pass the value of the X-Next-Token response header from the previous page to get the next page; leave empty for the first page.
team_idstring
Optional team identifier, as its UUID or public project ID (prj_...). Usually not needed, because the API key is already scoped to one project. Example: prj_8f3k2l9q
e2b_list_volumesList the persistent volumes in the E2B project.Read-only
List Volumes
List the persistent volumes in the E2B project. Returns an array of volumes with volumeID and name. Use this to find a volume to mount with e2b_create_sandbox. Use e2b_get_volume for a volume's access details.
Inputs
This tool takes no inputs.
e2b_assign_template_tagsAssign one or more tags to a build of an E2B template.Write
Assign Template Tags
Assign one or more tags to a build of an E2B template. Returns tags (the assigned tags) and buildID. Use this to label a build, for example as production. Use e2b_delete_template_tags to remove tags.
Inputs
tagsarrayrequired
Tags to assign to the target build. Example: ["production", "v2"]
targetstringrequired
The template build to tag, written as template-name:existing-tag. Example: my-template:latest
e2b_connect_sandboxConnect to an E2B sandbox, resuming it first if it is paused, and extend its time to live.Write
Connect Sandbox
Connect to an E2B sandbox, resuming it first if it is paused, and extend its time to live. Returns sandboxID, templateID, alias, envdVersion, envdAccessToken, trafficAccessToken and domain. Use this to resume a paused sandbox or to get a running sandbox's access tokens. The timeout only ever extends the sandbox's life; use e2b_set_sandbox_timeout to shorten it.
Inputs
sandbox_idstringrequired
ID of the sandbox to connect to, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
memoryboolean
Only used when the sandbox is paused. true (the API default) restores its memory; false cold-boots it from its disk state only.
timeoutinteger
Seconds from now after which the sandbox should expire. Only extends the current time to live. Defaults to 300. Example: 600default 300
e2b_create_sandboxStart a new E2B sandbox from a template, with an optional time to live, auto-pause, metadata, environment variables, network rules and volume mounts.Write
Create Sandbox
Start a new E2B sandbox from a template, with an optional time to live, auto-pause, metadata, environment variables, network rules and volume mounts. Returns the new sandbox's sandboxID, templateID, alias, envdVersion, envdAccessToken, trafficAccessToken and domain. Use this to start a sandbox. Use e2b_connect_sandbox to resume a paused one, and e2b_fork_sandbox to clone a running one.
Inputs
template_idstringrequired
ID or alias of the template to start the sandbox from. Use base for E2B's default template, or an ID from e2b_list_templates. Example: rki5dems9wqfm4r03t7g
allow_internet_accessboolean
Set to false to block all outbound internet access (same as denying 0.0.0.0/0). Leave empty to keep the default, which allows outbound access.
auto_pauseboolean
Set to true to pause the sandbox instead of killing it when the timeout runs out. Defaults to false.default false
auto_pause_memoryboolean
Only used when auto_pause is true. true (the API default) keeps a full memory snapshot on auto-pause; false keeps only the filesystem, and resuming then reboots the sandbox. false can't be combined with auto_resume.
auto_resumeboolean
Set to true to let a paused sandbox resume automatically when traffic reaches it. Leave empty for the API default (off).
env_varsobject
Environment variables to set inside the sandbox, as a JSON object of string values. Example: {"NODE_ENV": "production"}
metadataobject
String key-value pairs to attach to the sandbox, used later to filter e2b_list_sandboxes. Example: {"user": "abc", "app": "prod"}
networkobject
Egress and access rules for the sandbox. Supported keys: allowOut and denyOut (lists of CIDRs, IPs, or for allowOut also domains), allowPublicTraffic (false requires auth on sandbox URLs), maskRequestHost, httpsPorts, egressProxy and rules. Allowed entries win over denied ones. Example: {"allowOut": ["api.github.com"], "denyOut": ["0.0.0.0/0"]}
timeoutinteger
Time to live for the sandbox in seconds; it is killed (or paused, if auto_pause is true) when this runs out. Defaults to 300. Your plan caps the maximum. Example: 600default 300
volume_mountsarray
Volumes to mount in the sandbox. Each entry gives the volume's name (from e2b_list_volumes) and the absolute path to mount it at. Example: [{"name": "my-data", "path": "/mnt/data"}]
e2b_create_secretStore a new secret in E2B so sandboxes can use it through network rules without seeing its value.Write
Create Secret
Store a new secret in E2B so sandboxes can use it through network rules without seeing its value. Returns secretID, name, currentVersion, metadata, createdAt and updatedAt; the secret value is never returned. Use this for a new secret name; a name that already exists returns 409. Use e2b_update_secret to rotate an existing secret's value.
Inputs
namestringrequired
Name of the secret, unique in the project: 1-128 letters, digits, underscores or hyphens, stored in lowercase. It can't start with sec_. Example: stripe_api_key
valuestringrequired
The secret value to store, such as an API key. E2B stores it encrypted and injects it into matching outbound requests from sandboxes; it is never returned. Example: sk_live_...
metadataobject
String key-value labels for the secret, at most 32 entries. Example: {"environment": "production"}
e2b_create_snapshotCreate a persistent snapshot of an E2B sandbox's current state that new sandboxes can start from.Write
Create Snapshot
Create a persistent snapshot of an E2B sandbox's current state that new sandboxes can start from. Returns snapshotID and names (the snapshot's template names). Use this to save a sandbox's state beyond its lifetime; start from it later with e2b_create_sandbox using a returned name. Use e2b_fork_sandbox to copy a sandbox right away.
Inputs
sandbox_idstringrequired
ID of the sandbox to snapshot, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
memoryboolean
Set to false to save only the filesystem: smaller and faster, but sandboxes started from it boot fresh. Leave empty for the API default (full memory snapshot).
namestring
Optional snapshot name. If a snapshot with this name already exists, the new snapshot becomes a new build of it. Example: my-snapshot
e2b_create_volumeCreate a persistent E2B volume that can be mounted into sandboxes.Write
Create Volume
Create a persistent E2B volume that can be mounted into sandboxes. Returns volumeID, name, token and domain. Use this to make shared storage that outlives sandboxes, then mount it by name with e2b_create_sandbox.
Inputs
namestringrequired
Name of the new volume; you use it to mount the volume in a sandbox. Example: my-data
e2b_fork_sandboxFork a running E2B sandbox: snapshot it in place, with full memory, and start one or more new sandboxes from that snapshot.Write
Fork Sandbox
Fork a running E2B sandbox: snapshot it in place, with full memory, and start one or more new sandboxes from that snapshot. Returns an array with one result per fork, each holding either sandbox (sandboxID, templateID, envdAccessToken, domain and more) or error. Use this to clone a sandbox's exact live state. Use e2b_create_snapshot to save a reusable snapshot without starting new sandboxes.
Inputs
sandbox_idstringrequired
ID of the sandbox to fork, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
countinteger
Number of forked sandboxes to create, from 1 to 100. Defaults to 1. Each fork succeeds or fails on its own. Example: 3default 1
timeoutinteger
Time to live for each new forked sandbox, in seconds. Defaults to 15. Example: 300default 15
e2b_pause_sandboxPause a running E2B sandbox so it stops billing but keeps its state.Write
Pause Sandbox
Pause a running E2B sandbox so it stops billing but keeps its state. Returns an empty response (HTTP 204) when the sandbox is paused. Use this to suspend a sandbox and come back later with e2b_connect_sandbox. Use e2b_kill_sandbox to end it instead.
Inputs
sandbox_idstringrequired
ID of the sandbox to pause, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
memoryboolean
true (the API default) captures a full memory snapshot. false persists only the filesystem, so resuming reboots the sandbox and loses in-memory state.
e2b_refresh_sandboxKeep an E2B sandbox alive longer by refreshing its time to live.Write
Refresh Sandbox
Keep an E2B sandbox alive longer by refreshing its time to live. Returns an empty response (HTTP 204) when the sandbox is refreshed. Use this as a keep-alive for a running sandbox. Use e2b_set_sandbox_timeout to set an exact expiry.
Inputs
sandbox_idstringrequired
ID of the sandbox to refresh, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
durationinteger
Seconds to keep the sandbox alive, from 0 to 3600. Leave empty for the API default. Example: 300
e2b_set_sandbox_timeoutSet when an E2B sandbox expires, counted in seconds from now.Write
Set Sandbox Timeout
Set when an E2B sandbox expires, counted in seconds from now. Returns an empty response (HTTP 204) when the timeout is set. Use this to shorten or lengthen a sandbox's life; each call replaces the previous timeout. Use e2b_refresh_sandbox to add time without replacing it.
- Idempotent
Inputs
sandbox_idstringrequired
ID of the sandbox to update, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
timeoutintegerrequired
Seconds from now after which the sandbox should expire. Replaces the current timeout. Example: 900
e2b_update_sandbox_networkReplace the egress network rules of a running E2B sandbox.Write
Update Sandbox Network
Replace the egress network rules of a running E2B sandbox. Returns an empty response (HTTP 204) when the rules are updated. Use this to change what a sandbox can reach after it starts. Any field you leave out is cleared, so send the full set of rules you want. Set rules at start with e2b_create_sandbox's network input.
- Idempotent
Inputs
sandbox_idstringrequired
ID of the sandbox to update, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx
allow_internet_accessboolean
Set to false to block all outbound internet access (same as denying 0.0.0.0/0).
allow_outarray
Destinations the sandbox may reach: CIDR blocks, bare IPs or domain names (wildcards like *.example.com allowed). Allowed entries win over denied ones. Example: ["api.github.com", "8.8.8.8/32"]
deny_outarray
CIDR blocks or IPs the sandbox may not reach. Domain names aren't supported here. Example: ["0.0.0.0/0"]
egress_proxyobject
SOCKS5 proxy that outbound TCP is tunneled through after allow/deny filtering. Needs an address in host:port form; username, password and a tls object ({"enabled": true}) are optional. Example: {"address": "proxy.example.com:1080"}
rulesobject
Per-domain transforms for outbound HTTPS requests, keyed by domain (exact or *.wildcard), each a list of rules that inject headers. Replaces all existing rules. Rules don't grant access; allow the domain in allow_out too. Example: {"api.example.com": [{"transform": {"headers": {"X-Env": "sandbox"}}}]}
e2b_update_secretRotate an E2B secret by storing a new value as its next version.Write
Update Secret
Rotate an E2B secret by storing a new value as its next version. Returns secretID, name, currentVersion, metadata, createdAt and updatedAt; the secret value is never returned. Use this to change an existing secret's value; running sandboxes pick it up on their next request. Use e2b_create_secret for a new name.
Inputs
secret_idstringrequired
The secret to update: its ID (sec_...) or its name. Example: stripe_api_key
valuestringrequired
The secret value to store, such as an API key. E2B stores it encrypted and injects it into matching outbound requests from sandboxes; it is never returned. Example: sk_live_...
metadataobject
String key-value labels for the secret, at most 32 entries. Example: {"environment": "production"}
e2b_update_templateMake an E2B template public or private.Write
Update Template
Make an E2B template public or private. Returns names, the template's names. Use this to share a template with other projects (public) or restrict it to your team (private).
- Idempotent
Inputs
publicbooleanrequired
true makes the template usable by any E2B project; false limits it to your team.
template_idstringrequired
ID of the template to update, as returned by e2b_list_templates (templateID). Example: rki5dems9wqfm4r03t7g
e2b_delete_secretRevoke an E2B secret and schedule its stored versions for cleanup.Destructive
Delete Secret
Revoke an E2B secret and schedule its stored versions for cleanup. Returns an empty response (HTTP 204) when the secret is deleted. Use this to remove a secret for good. Use e2b_update_secret to change its value instead.
- Idempotent
Inputs
secret_idstringrequired
The secret to delete: its ID (sec_...) or its name. Example: stripe_api_key
e2b_delete_templateDelete an E2B template.Destructive
Delete Template
Delete an E2B template. Returns an empty response (HTTP 204) when the template is deleted. Use this to remove a template you no longer need. Use e2b_delete_template_tags to remove only some tags.
- Idempotent
Inputs
template_idstringrequired
ID of the template to delete, as returned by e2b_list_templates (templateID). Example: rki5dems9wqfm4r03t7g
e2b_delete_template_tagsRemove one or more tags from an E2B template.Destructive
Delete Template Tags
Remove one or more tags from an E2B template. Returns an empty response (HTTP 204) when the tags are deleted. Use this to untag builds without deleting the template. Use e2b_delete_template to delete the whole template.
- Idempotent
Inputs
namestringrequired
Name of the template to remove tags from. Example: my-template
tagsarrayrequired
Tags to delete from the template. Example: ["v1"]
e2b_delete_volumeDelete an E2B volume and the data stored in it.Destructive
Delete Volume
Delete an E2B volume and the data stored in it. Returns an empty response (HTTP 204) when the volume is deleted. Use this to remove storage you no longer need. Use e2b_list_volumes to find the volume ID.
- Idempotent
Inputs
volume_idstringrequired
ID of the volume, as returned by e2b_list_volumes (volumeID). Example: 7d3f9a2e-1c4b-4e8a-9f60-2b5d8c1e4a73
e2b_kill_sandboxKill an E2B sandbox, stopping it and discarding its state.Destructive
Kill Sandbox
Kill an E2B sandbox, stopping it and discarding its state. Returns an empty response (HTTP 204) when the sandbox is killed. Use this to end a sandbox for good. Use e2b_pause_sandbox to stop it but keep its state for later.
- Idempotent
Inputs
sandbox_idstringrequired
ID of the sandbox to kill, as returned by e2b_create_sandbox or e2b_list_sandboxes (sandboxID). Example: iiny0783cype8gmoawzmx

Setup

Install the SDK

Set your credentials

Create the E2B connection

Authorize a user and make your first call

Tools

Call it

Returns

Get Sandbox

Inputs

Get Sandbox Logs

Inputs

Get Sandbox Metrics

Inputs

Get Secret

Inputs

Get Team Max Metric

Inputs

Get Team Metrics

Inputs

Get Template

Inputs

Get Template Build Logs

Inputs

Get Template Build Status

Inputs

Get Template by Alias

Inputs

Get Volume

Inputs

List Events

Inputs

List Sandbox Events

Inputs

List Sandbox Metrics

Inputs

List Sandboxes

Inputs

List Secrets

Inputs

List Snapshots

Inputs

List Template Tags

Inputs

List Templates

Inputs

List Volumes

Inputs

Assign Template Tags

Inputs

Connect Sandbox

Inputs

Create Sandbox

Inputs

Create Secret

Inputs

Create Snapshot

Inputs

Create Volume

Inputs

Fork Sandbox

Inputs

Pause Sandbox

Inputs

Refresh Sandbox

Inputs

Set Sandbox Timeout

Inputs

Update Sandbox Network

Inputs

Update Secret

Inputs

Update Template

Inputs

Delete Secret

Inputs

Delete Template

Inputs

Delete Template Tags

Inputs