Run a command and stream output over SSE
Runs a command and streams its output as Server-Sent Events while it
runs. Each data: line is a JSON object: an output chunk
({"stdout":"..."} or {"stderr":"..."}), the terminal event
({"exit_code":N,"finished":true}), or an error
({"error":"...","finished":true}). The stream closes when the command
exits. The sandbox must be running; a paused sandbox returns 503.
Activate it first with POST /sandboxes/{sandbox_id}/activate (the SDKs
do this automatically).
timeout_s is a hard runtime limit: the command is killed after that
many seconds regardless of output, exiting with code 124.
curl --request POST \
--url https://sandbox.superserve.ai/exec/stream \
--header 'Content-Type: application/json' \
--header 'X-Access-Token: <api-key>' \
--data '
{
"command": "<string>",
"args": [
"<string>"
],
"env": {},
"working_dir": "<string>",
"timeout_s": 30,
"user": "root"
}
'import requests
url = "https://sandbox.superserve.ai/exec/stream"
payload = {
"command": "<string>",
"args": ["<string>"],
"env": {},
"working_dir": "<string>",
"timeout_s": 30,
"user": "root"
}
headers = {
"X-Access-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Access-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
command: '<string>',
args: ['<string>'],
env: {},
working_dir: '<string>',
timeout_s: 30,
user: 'root'
})
};
fetch('https://sandbox.superserve.ai/exec/stream', 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://sandbox.superserve.ai/exec/stream",
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([
'command' => '<string>',
'args' => [
'<string>'
],
'env' => [
],
'working_dir' => '<string>',
'timeout_s' => 30,
'user' => 'root'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/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://sandbox.superserve.ai/exec/stream"
payload := strings.NewReader("{\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {},\n \"working_dir\": \"<string>\",\n \"timeout_s\": 30,\n \"user\": \"root\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Token", "<api-key>")
req.Header.Add("Content-Type", "application/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://sandbox.superserve.ai/exec/stream")
.header("X-Access-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {},\n \"working_dir\": \"<string>\",\n \"timeout_s\": 30,\n \"user\": \"root\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.superserve.ai/exec/stream")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {},\n \"working_dir\": \"<string>\",\n \"timeout_s\": 30,\n \"user\": \"root\"\n}"
response = http.request(request)
puts response.read_body{
"timestamp": "2023-11-07T05:31:56Z",
"stdout": "<string>",
"stderr": "<string>",
"finished": true,
"exit_code": 123,
"error": "<string>",
"code": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Per-sandbox token returned by create, resume, and activate. Grants access to a single sandbox's files and commands. Distinct from the team X-API-Key.
Body
Command to execute. Wrapped in /bin/sh -c unless args is provided.
1If provided, command is used as the binary and args as arguments (no shell wrapping).
Environment variables for the command.
Show child attributes
Show child attributes
Working directory (default the template's working directory, else the user's home, which is /home/user for root).
Timeout in seconds.
User to run the command as: a name, a uid, name:group, or uid:gid (default the template's user). An unknown user or group fails as bad_request (400 on POST /exec).
"root"
Response
A Server-Sent Events stream of output and lifecycle events.
One Server-Sent Event from POST /exec/stream, delivered as a data: line carrying this JSON object. Output events carry stdout or stderr (each with a timestamp); the terminal event carries finished: true with exit_code, or error and code if the command could not be run. The stream may also include SSE comment keepalive lines (: keepalive), which carry no data.
RFC 3339 time the event was emitted (output and terminal events).
A chunk of standard output.
A chunk of standard error.
Present and true on the terminal event.
Process exit code, on the terminal event.
Error message if the command could not be run.
Error code accompanying error (e.g. bad_request, exec_failed).
curl --request POST \
--url https://sandbox.superserve.ai/exec/stream \
--header 'Content-Type: application/json' \
--header 'X-Access-Token: <api-key>' \
--data '
{
"command": "<string>",
"args": [
"<string>"
],
"env": {},
"working_dir": "<string>",
"timeout_s": 30,
"user": "root"
}
'import requests
url = "https://sandbox.superserve.ai/exec/stream"
payload = {
"command": "<string>",
"args": ["<string>"],
"env": {},
"working_dir": "<string>",
"timeout_s": 30,
"user": "root"
}
headers = {
"X-Access-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Access-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
command: '<string>',
args: ['<string>'],
env: {},
working_dir: '<string>',
timeout_s: 30,
user: 'root'
})
};
fetch('https://sandbox.superserve.ai/exec/stream', 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://sandbox.superserve.ai/exec/stream",
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([
'command' => '<string>',
'args' => [
'<string>'
],
'env' => [
],
'working_dir' => '<string>',
'timeout_s' => 30,
'user' => 'root'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/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://sandbox.superserve.ai/exec/stream"
payload := strings.NewReader("{\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {},\n \"working_dir\": \"<string>\",\n \"timeout_s\": 30,\n \"user\": \"root\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Token", "<api-key>")
req.Header.Add("Content-Type", "application/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://sandbox.superserve.ai/exec/stream")
.header("X-Access-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {},\n \"working_dir\": \"<string>\",\n \"timeout_s\": 30,\n \"user\": \"root\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.superserve.ai/exec/stream")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ],\n \"env\": {},\n \"working_dir\": \"<string>\",\n \"timeout_s\": 30,\n \"user\": \"root\"\n}"
response = http.request(request)
puts response.read_body{
"timestamp": "2023-11-07T05:31:56Z",
"stdout": "<string>",
"stderr": "<string>",
"finished": true,
"exit_code": 123,
"error": "<string>",
"code": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}