Skip to content

E2B

Nuget package dotnet License: MIT Discord

Features 🔥

  • Fully generated C# SDK based on official E2B OpenAPI specification using AutoSDK
  • Same day update to support new features
  • Updated and supported automatically if there are no breaking changes
  • All modern .NET features - nullability, trimming, NativeAOT, etc.
  • Support .Net Framework/.Net Standard 2.0

Usage

1
2
3
using E2B;

using var client = new E2BClient(apiKey);

List Sandboxes

Basic example showing how to create a client and list running sandboxes.

1
2
3
4
using var client = new E2BClient(apiKey);

// List all currently running sandboxes.
var sandboxes = await client.Sandboxes.GetSandboxes2Async();

Run a Sandbox Command

Create a sandbox and run a Bash command inside it.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
using var client = new E2BClient(apiKey);
var sandbox = await client.Sandboxes.CreateSandboxesAsync(
    new NewSandbox
    {
        TemplateID = "base",
        Timeout = 300,
        Secure = true,
    });

try
{
    // Stream output while a foreground command runs.
    var result = await sandbox.Commands.RunAsync(
        "echo 'Hello from E2B!'",
        new SandboxCommandOptions
        {
            OnStdout = Console.Write,
            OnStderr = Console.Error.Write,
        });

    // Start a background command with an open standard-input stream.
    await using var handle = await sandbox.Commands.StartAsync(
        "read line; echo \"Received: $line\"",
        new SandboxCommandOptions
        {
            Stdin = true,
            OutputBufferCapacity = 8,
        });

    Console.WriteLine($"Background process ID: {handle.ProcessId}");
    var process = (await sandbox.Commands.ListAsync())
        .Single(process => process.ProcessId == handle.ProcessId);
    Console.WriteLine($"Running command: {process.Command}");

    // Disconnect without stopping the process, then reconnect by PID.
    await handle.DisconnectAsync();
    await using var reconnectedHandle = await sandbox.Commands.ConnectAsync(
        handle.ProcessId,
        new SandboxCommandConnectOptions { OutputBufferCapacity = 8 });
    await reconnectedHandle.SendStdinAsync("hello\n");
    await reconnectedHandle.CloseStdinAsync();

    // Consume stdout and stderr asynchronously in arrival order.
    await foreach (var chunk in reconnectedHandle.ReadOutputAsync())
    {
        Console.Write(chunk.Data);
    }

    var backgroundResult = await reconnectedHandle.WaitAsync();
}
finally
{
    await client.Sandboxes.DeleteSandboxesBySandboxIDAsync(sandbox.SandboxID);
}

Templates

List available sandbox templates.

1
2
3
4
using var client = new E2BClient(apiKey);

// List all sandbox templates available in your team.
var templates = await client.Templates.GetTemplatesAsync();

Snapshots

List sandbox snapshots for resuming paused sandboxes.

1
2
3
4
5
using var client = new E2BClient(apiKey);

// List all snapshots with pagination.
var snapshots = await client.Snapshots.GetSnapshotsAsync(
    limit: 10);

Support

Priority place for bugs: https://github.com/tryAGI/E2B/issues
Priority place for ideas and general questions: https://github.com/tryAGI/E2B/discussions
Discord: https://discord.gg/Ca2xhfBf3v

Acknowledgments

JetBrains logo

This project is supported by JetBrains through the Open Source Support Program.