Skip to main content
POST
/
process.Process
/
Start
Start
curl --request POST \
  --url https://{port}-{sandboxID}.e2b.app/process.Process/Start \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/connect+json' \
  --header 'X-Access-Token: <api-key>' \
  --data '
{
  "process": {
    "cmd": "<string>",
    "args": [
      "<string>"
    ],
    "envs": {},
    "cwd": "<string>"
  },
  "pty": {
    "size": {
      "cols": 123,
      "rows": 123
    }
  },
  "tag": "<string>",
  "stdin": true
}
'
import requests

url = "https://{port}-{sandboxID}.e2b.app/process.Process/Start"

payload = {
    "process": {
        "cmd": "<string>",
        "args": ["<string>"],
        "envs": {},
        "cwd": "<string>"
    },
    "pty": { "size": {
            "cols": 123,
            "rows": 123
        } },
    "tag": "<string>",
    "stdin": True
}
headers = {
    "Connect-Protocol-Version": "<connect-protocol-version>",
    "X-Access-Token": "<api-key>",
    "Content-Type": "application/connect+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    'X-Access-Token': '<api-key>',
    'Content-Type': 'application/connect+json'
  },
  body: JSON.stringify({
    process: {cmd: '<string>', args: ['<string>'], envs: {}, cwd: '<string>'},
    pty: {size: {cols: 123, rows: 123}},
    tag: '<string>',
    stdin: true
  })
};

fetch('https://{port}-{sandboxID}.e2b.app/process.Process/Start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{port}-{sandboxID}.e2b.app/process.Process/Start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'process' => [
        'cmd' => '<string>',
        'args' => [
                '<string>'
        ],
        'envs' => [
                
        ],
        'cwd' => '<string>'
    ],
    'pty' => [
        'size' => [
                'cols' => 123,
                'rows' => 123
        ]
    ],
    'tag' => '<string>',
    'stdin' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Connect-Protocol-Version: <connect-protocol-version>",
    "Content-Type: application/connect+json",
    "X-Access-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{port}-{sandboxID}.e2b.app/process.Process/Start"

	payload := strings.NewReader("{\n  \"process\": {\n    \"cmd\": \"<string>\",\n    \"args\": [\n      \"<string>\"\n    ],\n    \"envs\": {},\n    \"cwd\": \"<string>\"\n  },\n  \"pty\": {\n    \"size\": {\n      \"cols\": 123,\n      \"rows\": 123\n    }\n  },\n  \"tag\": \"<string>\",\n  \"stdin\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	req.Header.Add("X-Access-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/connect+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{port}-{sandboxID}.e2b.app/process.Process/Start")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("X-Access-Token", "<api-key>")
  .header("Content-Type", "application/connect+json")
  .body("{\n  \"process\": {\n    \"cmd\": \"<string>\",\n    \"args\": [\n      \"<string>\"\n    ],\n    \"envs\": {},\n    \"cwd\": \"<string>\"\n  },\n  \"pty\": {\n    \"size\": {\n      \"cols\": 123,\n      \"rows\": 123\n    }\n  },\n  \"tag\": \"<string>\",\n  \"stdin\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{port}-{sandboxID}.e2b.app/process.Process/Start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/connect+json'
request.body = "{\n  \"process\": {\n    \"cmd\": \"<string>\",\n    \"args\": [\n      \"<string>\"\n    ],\n    \"envs\": {},\n    \"cwd\": \"<string>\"\n  },\n  \"pty\": {\n    \"size\": {\n      \"cols\": 123,\n      \"rows\": 123\n    }\n  },\n  \"tag\": \"<string>\",\n  \"stdin\": true\n}"

response = http.request(request)
puts response.read_body
{
  "event": {
    "data": {
      "pty": "aSDinaTvuI8gbWludGxpZnk="
    }
  }
}
{
  "message": "<string>",
  "code": 123,
  "sandboxID": "<string>"
}

Authorizations

​
X-Access-Token
string
header
required

Sandbox access token (envdAccessToken) for authenticating requests to a running sandbox. Returned by: POST /sandboxes (on create), POST /sandboxes/{sandboxID}/connect (on connect), POST /sandboxes/{sandboxID}/resume (on resume), and GET /sandboxes/{sandboxID} (for running or paused sandboxes).

Headers

​
Connect-Protocol-Version
number
required

Define the version of the Connect protocol

​
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/connect+json
​
process
process · object
​
pty
PTY · object | null
​
tag
string | null
​
stdin
boolean | null

This is optional for backwards compatibility. We default to true. New SDK versions will set this to false by default.

Response

Stream of StartResponse events

​
event
event · object