Sandboxes

Choose the provider for a new sandbox

Orders the providers the team lists for one new sandbox with CostGraph AutoPilot. providers are ComputeSDK provider names in the team’s order; a repeated name counts once. Send the sandbox size as size_class (xs, sm, md, lg, xl or 2xl), or as vcpus and memory_mib; size_class wins when both are sent. Only the first 20 providers are priced, and a name CostGraph does not recognise is kept without a price. The team’s first provider is the baseline. Providers are compared on expected_cost, the USD cost of one sandbox of the size running for expected_seconds: the run time rounded up to the provider’s billing increment and at least its minimum billed time, at its price per hour. expected_seconds is the median run time, at most 24 hours, of the team’s stopped sandboxes of the same size that started in the last 30 days when there are at least 20, otherwise 600. startup_p50_ms and success_rate come from ComputeSDK’s public burst benchmark (github.com/computesdk/benchmarks, MIT), which starts 100 sandboxes at once: the median milliseconds from a create request to the first command in that sandbox, and the share of the 100 starts that succeeded; both are null for a provider it does not benchmark. When AutoPilot for sandboxes is on, the order follows the team’s policy. cheapest: providers with a price for the size, lowest expected_cost first, then the others; a provider whose startup_p50_ms is more than twice the baseline’s goes after the other priced providers, and a missing start time never holds a provider back. fastest: providers whose expected_cost is no more than the baseline’s, fastest start first, then lower expected_cost, with those without a start time after them by expected_cost, then dearer providers in the same way, then those without a price; the baseline stays first unless a provider starts strictly faster than it. balanced: a provider whose expected_cost is no more than the baseline’s and whose start time is within the baseline’s start time plus the larger of 100 ms and 10% (the limit) scores (baseline expected_cost - its expected_cost) x (limit - its startup_p50_ms); providers scoring above zero come first, highest score first, then faster start, then lower expected_cost; then the other priced providers by start time (none last), then expected_cost; then those without a price; the baseline stays first when no provider scores above zero. In every policy a provider other than the baseline whose success_rate is below 0.95 moves to the end, and remaining ties keep the team’s order. reason is the policy (cheapest, fastest or balanced) when the first provider changed, otherwise no_better_candidate. The order stays the team’s when AutoPilot is off (reason off), when no size is sent (reason no_size) and when the baseline has no price for the size (reason baseline_not_priced). candidates lists every provider in the returned order with its USD price per hour, expected_cost, billing_increment_seconds and minimum_billed_seconds for the size when known. Always answers 200 when the body has at least one provider: when CostGraph cannot choose (rate_limited, billing_required or error), the order is the team’s, candidates is empty and decision_id is empty. When the reason is billing_required, billing_url links to the billing settings. Send decision_id back with the sandbox’s started event.

POST

api

tenant

sandboxes

route

Choose the provider for a new sandbox

curl --request POST \
  --url https://api.costgraph.ai/api/v1/tenant/sandboxes/route \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "providers": [
    "e2b",
    "daytona"
  ],
  "memory_mib": 4096,
  "size_class": "md",
  "vcpus": 2
}
'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/sandboxes/route"

payload = {
    "providers": ["e2b", "daytona"],
    "memory_mib": 4096,
    "size_class": "md",
    "vcpus": 2
}
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({providers: ['e2b', 'daytona'], memory_mib: 4096, size_class: 'md', vcpus: 2})
};

fetch('https://api.costgraph.ai/api/v1/tenant/sandboxes/route', 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/route",
  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([
    'providers' => [
        'e2b',
        'daytona'
    ],
    'memory_mib' => 4096,
    'size_class' => 'md',
    'vcpus' => 2
  ]),
  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/route"

	payload := strings.NewReader("{\n  \"providers\": [\n    \"e2b\",\n    \"daytona\"\n  ],\n  \"memory_mib\": 4096,\n  \"size_class\": \"md\",\n  \"vcpus\": 2\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/route")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"providers\": [\n    \"e2b\",\n    \"daytona\"\n  ],\n  \"memory_mib\": 4096,\n  \"size_class\": \"md\",\n  \"vcpus\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/sandboxes/route")

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  \"providers\": [\n    \"e2b\",\n    \"daytona\"\n  ],\n  \"memory_mib\": 4096,\n  \"size_class\": \"md\",\n  \"vcpus\": 2\n}"

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

{
  "message": "some message",
  "status": "success",
  "data": {
    "candidates": [
      {
        "priced": true,
        "provider": "<string>",
        "billing_increment_seconds": 123,
        "expected_cost": 123,
        "minimum_billed_seconds": 123,
        "price_per_hour": 123,
        "sku": "<string>",
        "startup_p50_ms": 123,
        "success_rate": 123
      }
    ],
    "decision_id": "<string>",
    "order": [
      "<string>"
    ],
    "provider": "<string>",
    "reason": "cheapest",
    "billing_url": "<string>",
    "expected_seconds": 123
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Authorizations

X-API-Key

string

header

required

API key for machine-to-machine authentication

Headers

X-CostGraph-Tenant-ID

string

Tenant ID

Body

application/json

The team's providers and the sandbox size

providers

string[]

required

Minimum array length: 1

Example:

["e2b", "daytona"]

memory_mib

integer

Example:

4096

size_class

enum<string>

Available options:

xs,

sm,

md,

lg,

xl,

2xl

Example:

"md"

vcpus

integer

Example:

2

Response

message

string

required

Example:

"some message"

status

string

required

Example:

"success"

data

object

Show child attributes

Choose the provider for a new sandbox

curl --request POST \
  --url https://api.costgraph.ai/api/v1/tenant/sandboxes/route \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "providers": [
    "e2b",
    "daytona"
  ],
  "memory_mib": 4096,
  "size_class": "md",
  "vcpus": 2
}
'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/sandboxes/route"

payload = {
    "providers": ["e2b", "daytona"],
    "memory_mib": 4096,
    "size_class": "md",
    "vcpus": 2
}
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({providers: ['e2b', 'daytona'], memory_mib: 4096, size_class: 'md', vcpus: 2})
};

fetch('https://api.costgraph.ai/api/v1/tenant/sandboxes/route', 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/route",
  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([
    'providers' => [
        'e2b',
        'daytona'
    ],
    'memory_mib' => 4096,
    'size_class' => 'md',
    'vcpus' => 2
  ]),
  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/route"

	payload := strings.NewReader("{\n  \"providers\": [\n    \"e2b\",\n    \"daytona\"\n  ],\n  \"memory_mib\": 4096,\n  \"size_class\": \"md\",\n  \"vcpus\": 2\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/route")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"providers\": [\n    \"e2b\",\n    \"daytona\"\n  ],\n  \"memory_mib\": 4096,\n  \"size_class\": \"md\",\n  \"vcpus\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/sandboxes/route")

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  \"providers\": [\n    \"e2b\",\n    \"daytona\"\n  ],\n  \"memory_mib\": 4096,\n  \"size_class\": \"md\",\n  \"vcpus\": 2\n}"

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

{
  "message": "some message",
  "status": "success",
  "data": {
    "candidates": [
      {
        "priced": true,
        "provider": "<string>",
        "billing_increment_seconds": 123,
        "expected_cost": 123,
        "minimum_billed_seconds": 123,
        "price_per_hour": 123,
        "sku": "<string>",
        "startup_p50_ms": 123,
        "success_rate": 123
      }
    ],
    "decision_id": "<string>",
    "order": [
      "<string>"
    ],
    "provider": "<string>",
    "reason": "cheapest",
    "billing_url": "<string>",
    "expected_seconds": 123
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Getting started

Endpoints

Choose the provider for a new sandbox

Authorizations

Headers

Body

Response