TemplateBase
Builder for E2B sandbox templates, and the entrypoint for the template API. Exposed as Template, which can be called as a factory.Implements
TemplateFromImageTemplateBuilderTemplateFinal
Constructors
Parameters
Returns
TemplateBase
Methods
addMcpServer()
Parameters
Returns
TemplateBuilder
Throws
If the base template is not mcp-gatewayExample
Implementation of
TemplateBuilder.addMcpServer
aptInstall()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.aptInstall
betaDevContainerPrebuild()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.betaDevContainerPrebuild
betaSetDevContainerStart()
Parameters
Returns
TemplateFinal
Example
Implementation of
TemplateBuilder.betaSetDevContainerStart
bunInstall()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.bunInstall
copy()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.copy
copyItems()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.copyItems
fromAlpineImage()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromArchImage()
latest: Arch is a rolling release and template provisioning
runs pacman -Syu, so pinning a tag would not change the built result.
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromAWSRegistry()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromBaseImage()
Returns
TemplateBuilder
Example
Implementation of
fromBunImage()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromDebianImage()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromDockerfile()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromFedoraImage()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromGCPRegistry()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromImage()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromNodeImage()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromPythonImage()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromTemplate()
Parameters
Returns
TemplateBuilder
Example
Implementation of
fromUbuntuImage()
Parameters
Returns
TemplateBuilder
Example
Implementation of
gitClone()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.gitClone
makeDir()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.makeDir
makeSymlink()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.makeSymlink
npmInstall()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.npmInstall
pipInstall()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.pipInstall
remove()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.remove
rename()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.rename
runCmd()
Call Signature
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.runCmd
Call Signature
Parameters
Returns
TemplateBuilder
Implementation of
TemplateBuilder.runCmd
setEnvs()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.setEnvs
setReadyCmd()
Parameters
Returns
TemplateFinal
Example
Implementation of
TemplateBuilder.setReadyCmd
setStartCmd()
Parameters
Returns
TemplateFinal
Example
Implementation of
TemplateBuilder.setStartCmd
setUser()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.setUser
setWorkdir()
Parameters
Returns
TemplateBuilder
Example
Implementation of
TemplateBuilder.setWorkdir
skipCache()
Returns
this
Example
Implementation of
TemplateBuilder.skipCache
aliasExists()
Parameters
Returns
Promise<boolean>
True if the alias exists, false otherwise
Deprecated
Useexists instead.
Example
assignTags()
Parameters
Returns
Promise<TemplateTagInfo>
Tag info with buildId and assigned tags
Example
build()
Call Signature
Parameters
Returns
Promise<BuildInfo>
Example
Call Signature
Parameters
Returns
Promise<BuildInfo>
Deprecated
Use the overload withname parameter instead.
Example
buildInBackground()
Call Signature
Parameters
Returns
Promise<BuildInfo>
Example
Call Signature
Parameters
Returns
Promise<BuildInfo>
Deprecated
Use the overload withname parameter instead.
Example
delete()
Parameters
Returns
Promise<boolean>
true if the template was deleted, false if it was not found
Throws
TemplateError if the API returns an error other than not foundExample
exists()
Parameters
Returns
Promise<boolean>
True if the name exists, false otherwise
Example
getBuildStatus()
Parameters
Returns
Promise<TemplateBuildStatusResponse>
Example
getTags()
Parameters
Returns
Promise<TemplateTag[]>
Array of tag details including tag name, buildId, and creation date
Example
list()
Parameters
Returns
TemplatePaginator
a TemplatePaginator that yields pages of templates.
Example
removeTags()
Parameters
Returns
Promise<void>
Example
toDockerfile()
Parameters
Returns
string
Dockerfile string representation
Throws
Error if the template is based on another E2B templatetoJSON()
Parameters
Returns
Promise<string>
JSON string representation of the template
TemplatePaginator
Paginator for listing templates.Example
Constructors
Parameters
Returns
TemplatePaginator
Accessors
hasNext
Get Signature
Returns
boolean
nextToken
Get Signature
Returns
undefined | string
Methods
nextItems()
Parameters
Returns
Promise<TemplateInfo[]>
List of items
Throws
Error if there are no more items to fetch. Call this method only ifhasNext is true.
Interfaces
TemplateBuilder
Main builder state for constructing templates. Provides methods for customizing the template environment.Methods
addMcpServer()
Parameters
Returns
TemplateBuilder
Throws
If the base template is not mcp-gatewayExample
aptInstall()
Parameters
Returns
TemplateBuilder
Example
betaDevContainerPrebuild()
Parameters
Returns
TemplateBuilder
Example
betaSetDevContainerStart()
Parameters
Returns
TemplateFinal
Example
bunInstall()
Parameters
Returns
TemplateBuilder
Example
copy()
Parameters
Returns
TemplateBuilder
Example
copyItems()
Parameters
Returns
TemplateBuilder
Example
gitClone()
Parameters
Returns
TemplateBuilder
Example
makeDir()
Parameters
Returns
TemplateBuilder
Example
makeSymlink()
Parameters
Returns
TemplateBuilder
Example
npmInstall()
Parameters
Returns
TemplateBuilder
Example
pipInstall()
Parameters
Returns
TemplateBuilder
Example
remove()
Parameters
Returns
TemplateBuilder
Example
rename()
Parameters
Returns
TemplateBuilder
Example
runCmd()
Call Signature
Parameters
Returns
TemplateBuilder
Example
Call Signature
Parameters
Returns
TemplateBuilder
Call Signature
Parameters
Returns
TemplateBuilder
setEnvs()
Parameters
Returns
TemplateBuilder
Example
setReadyCmd()
Parameters
Returns
TemplateFinal
Example
setStartCmd()
Parameters
Returns
TemplateFinal
Example
setUser()
Parameters
Returns
TemplateBuilder
Example
setWorkdir()
Parameters
Returns
TemplateBuilder
Example
skipCache()
Returns
this
Example
TemplateListOpts
Options for listing templates.Properties
apiHeaders?
apiKey?
Default
domain?
Default
E2B_DOMAIN // environment variable ore2b.app
headers?
Deprecated
UseapiHeaders instead.
httpVersion?
'2' multiplexes streams over shared connections;
'1.1' pins them to HTTP/1.1 with one connection per concurrent
request — for example when an intermediary on the path retires or
mishandles long-lived HTTP/2 connections. File uploads (files.write())
always use HTTP/1.1, whatever this option says, so that their bodies
cannot exhaust Node’s per-session HTTP/2 memory and reset other requests.
Only applies in Node.
Default
E2B_HTTP_VERSION // environment variable or'2'
limit?
Default
logger?
Logger interface—for example, console.
nextToken?
proxy?
Example
requestTimeoutMs?
Default
retries?
Should-Retry: true,
or 429/502/503/504 responses without that header. Should-Retry: false is
never retried. Waits for a valid Retry-After delta-seconds value, otherwise
exponential backoff with jitter from 100 ms to 10 s. Also retries failures
to establish the connection; network errors after the request is sent are
not retried.
A retry is skipped when its wait would exhaust the request timeout.
Retry waits use a 60-second total limit when request timeouts are disabled.
Set to 0 to disable retries. Defaults to 3 retries.
Default
Throws
InvalidArgumentError if the value is negative or not an integervalidateApiKey?
Deprecated
The API key format is no longer validated on the client side; this option has no effect.Type Aliases
BuildInfo
Type declaration
BuildOptions
BuildStatusReason
Type declaration
CopyItem
Type declaration
GetBuildStatusOptions
Type declaration
McpServerName
TemplateBuildStatus
TemplateBuildStatusResponse
Type declaration
TemplateClass
TemplateInfo
Type declaration
TemplateTag
Type declaration
TemplateTagInfo
Type declaration
Variables
Template
Template is the TemplateBase class, wrapped so it can also be
called as a factory returning a builder. The statics (Template.build,
Template.exists, …) resolve their connection options off the class they are
called on — so a subclass can bind its own defaults.
Param
Optional builder options, e.g. the file context path used to resolve relative paths passed tocopy