process

Execute a command

Execute a command and return process information.

Streaming: with Accept: application/x-ndjson (or Accept: text/event-stream, kept for compatibility) the response is NDJSON (Content-Type: application/x-ndjson), not SSE: one JSON object per line, {"type": "...", "data": "..."}. type is stdout or stderr (data is a raw output chunk, sent as soon as the process writes it, newlines included; if the process finished before any chunk was streamed, its output is sent instead as one event per line, without the newline), keepalive (every 5 seconds, no data), error (data is the message, ends the stream) or result (last event, data is the ProcessResponse as a JSON string).

POST

process

Execute a command

curl --request POST \
  --url https://{sandbox_host}/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "ls -la",
  "env": {
    "PORT": "3000"
  },
  "keepAlive": false,
  "maxRestarts": 3,
  "name": "my-process",
  "restartOnFailure": true,
  "stdin": false,
  "timeout": 30,
  "waitForCompletion": false,
  "waitForPorts": [
    3000,
    8080
  ],
  "workingDir": "/home/user"
}
'

import requests

url = "https://{sandbox_host}/process"

payload = {
    "command": "ls -la",
    "env": { "PORT": "3000" },
    "keepAlive": False,
    "maxRestarts": 3,
    "name": "my-process",
    "restartOnFailure": True,
    "stdin": False,
    "timeout": 30,
    "waitForCompletion": False,
    "waitForPorts": [3000, 8080],
    "workingDir": "/home/user"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    command: 'ls -la',
    env: {PORT: '3000'},
    keepAlive: false,
    maxRestarts: 3,
    name: 'my-process',
    restartOnFailure: true,
    stdin: false,
    timeout: 30,
    waitForCompletion: false,
    waitForPorts: [3000, 8080],
    workingDir: '/home/user'
  })
};

fetch('https://{sandbox_host}/process', 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_host}/process",
  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' => 'ls -la',
    'env' => [
        'PORT' => '3000'
    ],
    'keepAlive' => false,
    'maxRestarts' => 3,
    'name' => 'my-process',
    'restartOnFailure' => true,
    'stdin' => false,
    'timeout' => 30,
    'waitForCompletion' => false,
    'waitForPorts' => [
        3000,
        8080
    ],
    'workingDir' => '/home/user'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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_host}/process"

	payload := strings.NewReader("{\n  \"command\": \"ls -la\",\n  \"env\": {\n    \"PORT\": \"3000\"\n  },\n  \"keepAlive\": false,\n  \"maxRestarts\": 3,\n  \"name\": \"my-process\",\n  \"restartOnFailure\": true,\n  \"stdin\": false,\n  \"timeout\": 30,\n  \"waitForCompletion\": false,\n  \"waitForPorts\": [\n    3000,\n    8080\n  ],\n  \"workingDir\": \"/home/user\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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_host}/process")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"ls -la\",\n  \"env\": {\n    \"PORT\": \"3000\"\n  },\n  \"keepAlive\": false,\n  \"maxRestarts\": 3,\n  \"name\": \"my-process\",\n  \"restartOnFailure\": true,\n  \"stdin\": false,\n  \"timeout\": 30,\n  \"waitForCompletion\": false,\n  \"waitForPorts\": [\n    3000,\n    8080\n  ],\n  \"workingDir\": \"/home/user\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{sandbox_host}/process")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": \"ls -la\",\n  \"env\": {\n    \"PORT\": \"3000\"\n  },\n  \"keepAlive\": false,\n  \"maxRestarts\": 3,\n  \"name\": \"my-process\",\n  \"restartOnFailure\": true,\n  \"stdin\": false,\n  \"timeout\": 30,\n  \"waitForCompletion\": false,\n  \"waitForPorts\": [\n    3000,\n    8080\n  ],\n  \"workingDir\": \"/home/user\"\n}"

response = http.request(request)
puts response.read_body

{
  "command": "ls -la",
  "completedAt": "Wed, 01 Jan 2023 12:01:00 GMT",
  "exitCode": 0,
  "logs": "logs output",
  "name": "my-process",
  "pid": "1234",
  "startedAt": "Wed, 01 Jan 2023 12:00:00 GMT",
  "status": "running",
  "stderr": "stderr output",
  "stdout": "stdout output",
  "workingDir": "/home/user",
  "keepAlive": false,
  "maxRestarts": 3,
  "restartCount": 2,
  "restartOnFailure": true,
  "stdin": false
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

Authorizations

Authorization

string

header

required

Sandbox access token created through POST /v1/token.

Body

application/json

Process execution request

command

string

required

Example:

"ls -la"

env

object

Show child attributes

Example:

{ "PORT": "3000" }

keepAlive

boolean

Disable scale-to-zero while process runs. Default timeout is 600s (10 minutes). Set timeout to 0 for infinite.

Example:

false

maxRestarts

integer

Maximum number of restarts on failure. Set to a negative value (e.g. -1) for unlimited restarts.

Example:

3

name

string

Example:

"my-process"

restartOnFailure

boolean

Example:

true

stdin

boolean

Open a writable stdin pipe, fed via POST /process/{identifier}/stdin and closed via DELETE. The pipe does not survive a sandbox-api restart: the process then sees EOF.

Example:

false

timeout

integer

Timeout in seconds. When keepAlive is true, defaults to 600s (10 minutes). Set to 0 for infinite (no auto-kill).

Example:

30

waitForCompletion

boolean

Example:

false

waitForPorts

integer[]

Example:

[3000, 8080]

workingDir

string

Example:

"/home/user"

Response

Process information

command

string

required

Example:

"ls -la"

completedAt

string

required

Completion time, same format as startedAt. Empty string while the process runs

Example:

"Wed, 01 Jan 2023 12:01:00 GMT"

exitCode

integer

required

Example:

0

logs

string

required

Example:

"logs output"

name

string

required

Example:

"my-process"

pid

string

required

Example:

"1234"

startedAt

string

required

Start time as an HTTP date (RFC 1123, e.g. Wed, 01 Jan 2023 12:00:00 GMT)

Example:

"Wed, 01 Jan 2023 12:00:00 GMT"

status

enum<string>

required

Available options:

failed,

killed,

stopped,

running,

completed

Example:

"running"

stderr

string

required

Example:

"stderr output"

stdout

string

required

Example:

"stdout output"

workingDir

string

required

Example:

"/home/user"

keepAlive

boolean

Whether scale-to-zero is disabled for this process

Example:

false

maxRestarts

integer

Example:

3

restartCount

integer

Example:

2

restartOnFailure

boolean

Example:

true

stdin

boolean

Whether the process was started with a writable stdin pipe

Example:

false

⌘I

Execute a command

curl --request POST \
  --url https://{sandbox_host}/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "ls -la",
  "env": {
    "PORT": "3000"
  },
  "keepAlive": false,
  "maxRestarts": 3,
  "name": "my-process",
  "restartOnFailure": true,
  "stdin": false,
  "timeout": 30,
  "waitForCompletion": false,
  "waitForPorts": [
    3000,
    8080
  ],
  "workingDir": "/home/user"
}
'

import requests

url = "https://{sandbox_host}/process"

payload = {
    "command": "ls -la",
    "env": { "PORT": "3000" },
    "keepAlive": False,
    "maxRestarts": 3,
    "name": "my-process",
    "restartOnFailure": True,
    "stdin": False,
    "timeout": 30,
    "waitForCompletion": False,
    "waitForPorts": [3000, 8080],
    "workingDir": "/home/user"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    command: 'ls -la',
    env: {PORT: '3000'},
    keepAlive: false,
    maxRestarts: 3,
    name: 'my-process',
    restartOnFailure: true,
    stdin: false,
    timeout: 30,
    waitForCompletion: false,
    waitForPorts: [3000, 8080],
    workingDir: '/home/user'
  })
};

fetch('https://{sandbox_host}/process', 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_host}/process",
  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' => 'ls -la',
    'env' => [
        'PORT' => '3000'
    ],
    'keepAlive' => false,
    'maxRestarts' => 3,
    'name' => 'my-process',
    'restartOnFailure' => true,
    'stdin' => false,
    'timeout' => 30,
    'waitForCompletion' => false,
    'waitForPorts' => [
        3000,
        8080
    ],
    'workingDir' => '/home/user'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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_host}/process"

	payload := strings.NewReader("{\n  \"command\": \"ls -la\",\n  \"env\": {\n    \"PORT\": \"3000\"\n  },\n  \"keepAlive\": false,\n  \"maxRestarts\": 3,\n  \"name\": \"my-process\",\n  \"restartOnFailure\": true,\n  \"stdin\": false,\n  \"timeout\": 30,\n  \"waitForCompletion\": false,\n  \"waitForPorts\": [\n    3000,\n    8080\n  ],\n  \"workingDir\": \"/home/user\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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_host}/process")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"ls -la\",\n  \"env\": {\n    \"PORT\": \"3000\"\n  },\n  \"keepAlive\": false,\n  \"maxRestarts\": 3,\n  \"name\": \"my-process\",\n  \"restartOnFailure\": true,\n  \"stdin\": false,\n  \"timeout\": 30,\n  \"waitForCompletion\": false,\n  \"waitForPorts\": [\n    3000,\n    8080\n  ],\n  \"workingDir\": \"/home/user\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{sandbox_host}/process")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": \"ls -la\",\n  \"env\": {\n    \"PORT\": \"3000\"\n  },\n  \"keepAlive\": false,\n  \"maxRestarts\": 3,\n  \"name\": \"my-process\",\n  \"restartOnFailure\": true,\n  \"stdin\": false,\n  \"timeout\": 30,\n  \"waitForCompletion\": false,\n  \"waitForPorts\": [\n    3000,\n    8080\n  ],\n  \"workingDir\": \"/home/user\"\n}"

response = http.request(request)
puts response.read_body

{
  "command": "ls -la",
  "completedAt": "Wed, 01 Jan 2023 12:01:00 GMT",
  "exitCode": 0,
  "logs": "logs output",
  "name": "my-process",
  "pid": "1234",
  "startedAt": "Wed, 01 Jan 2023 12:00:00 GMT",
  "status": "running",
  "stderr": "stderr output",
  "stdout": "stdout output",
  "workingDir": "/home/user",
  "keepAlive": false,
  "maxRestarts": 3,
  "restartCount": 2,
  "restartOnFailure": true,
  "stdin": false
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

Reference

Inference API

Management API

Loops API

Training API

Frontier Gateway API

Sandbox runtime API

CLI reference

SDKs and clients

Configuration

Metrics

Integrations

Execute a command

Authorizations

Body

Response