Create a volume
Volume names can only contain letters, numbers, and hyphens.
Connect to an existing volume
You can connect to an existing volume by its ID using theconnect() method.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Create, connect to, list, inspect, and destroy volumes with the E2B SDK.
import { Volume } from 'e2b'
const volume = await Volume.create('my-volume')
console.log(volume.volumeId) // Volume ID
console.log(volume.name) // 'my-volume'
from e2b import Volume
volume = Volume.create('my-volume')
print(volume.volume_id) # Volume ID
print(volume.name) # 'my-volume'
connect() method.
import { Volume } from 'e2b'
const volume = await Volume.connect('volume-id')
console.log(volume.volumeId) // Volume ID
console.log(volume.name) // Volume name
from e2b import Volume
volume = Volume.connect('volume-id')
print(volume.volume_id) # Volume ID
print(volume.name) # Volume name
import { Volume } from 'e2b'
const volumes = await Volume.list()
console.log(volumes)
// [{ volumeId: '...', name: 'my-volume' }, ...]
from e2b import Volume
volumes = Volume.list()
print(volumes)
# [VolumeInfo(volume_id='...', name='my-volume'), ...]
import { Volume } from 'e2b'
const info = await Volume.getInfo('volume-id')
console.log(info)
// { volumeId: '...', name: 'my-volume' }
from e2b import Volume
info = Volume.get_info('volume-id')
print(info)
# VolumeInfo(volume_id='...', name='my-volume')
import { Volume } from 'e2b'
const success = await Volume.destroy('volume-id')
console.log(success) // true
from e2b import Volume
success = Volume.destroy('volume-id')
print(success) # True
Was this page helpful?