Sandboxes
Run a command in a sandbox
Runs a shell command in a running sandbox started through this API or the CostGraph MCP tools and returns its exit code and output. stdout and stderr hold at most 256 KiB each, and truncated is true when either was cut. timeout_ms limits the command, up to 55000; background true starts the command and returns at once. A sandbox the provider has ended is recorded as stopped and answers 404.
POST
/
api
/
v1
/
tenant
/
sandboxes
/
{provider}
/
{sandbox_id}
/
exec
Run a command in a sandbox
curl --request POST \
--url https://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"command": "<string>",
"background": true,
"cwd": "<string>",
"env": {},
"timeout_ms": 27500
}
'import requests
url = "https://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec"
payload = {
"command": "<string>",
"background": True,
"cwd": "<string>",
"env": {},
"timeout_ms": 27500
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
command: '<string>',
background: true,
cwd: '<string>',
env: {},
timeout_ms: 27500
})
};
fetch('https://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec', 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://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec",
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>',
'background' => true,
'cwd' => '<string>',
'env' => [
],
'timeout_ms' => 27500
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec"
payload := strings.NewReader("{\n \"command\": \"<string>\",\n \"background\": true,\n \"cwd\": \"<string>\",\n \"env\": {},\n \"timeout_ms\": 27500\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"command\": \"<string>\",\n \"background\": true,\n \"cwd\": \"<string>\",\n \"env\": {},\n \"timeout_ms\": 27500\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"command\": \"<string>\",\n \"background\": true,\n \"cwd\": \"<string>\",\n \"env\": {},\n \"timeout_ms\": 27500\n}"
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"exit_code": 123,
"stderr": "<string>",
"stdout": "<string>",
"truncated": true
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}Body
application/json
Command
Was this page helpful?
⌘I
Run a command in a sandbox
curl --request POST \
--url https://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"command": "<string>",
"background": true,
"cwd": "<string>",
"env": {},
"timeout_ms": 27500
}
'import requests
url = "https://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec"
payload = {
"command": "<string>",
"background": True,
"cwd": "<string>",
"env": {},
"timeout_ms": 27500
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
command: '<string>',
background: true,
cwd: '<string>',
env: {},
timeout_ms: 27500
})
};
fetch('https://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec', 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://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec",
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>',
'background' => true,
'cwd' => '<string>',
'env' => [
],
'timeout_ms' => 27500
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec"
payload := strings.NewReader("{\n \"command\": \"<string>\",\n \"background\": true,\n \"cwd\": \"<string>\",\n \"env\": {},\n \"timeout_ms\": 27500\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"command\": \"<string>\",\n \"background\": true,\n \"cwd\": \"<string>\",\n \"env\": {},\n \"timeout_ms\": 27500\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.costgraph.ai/api/v1/tenant/sandboxes/{provider}/{sandbox_id}/exec")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"command\": \"<string>\",\n \"background\": true,\n \"cwd\": \"<string>\",\n \"env\": {},\n \"timeout_ms\": 27500\n}"
response = http.request(request)
puts response.read_body{
"message": "some message",
"status": "success",
"data": {
"exit_code": 123,
"stderr": "<string>",
"stdout": "<string>",
"truncated": true
}
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}{
"message": "some message",
"status": "error"
}