Run a command

curl --request POST \
  --url https://api.cool.computer/api/computers/{id}/exec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "uname -a"
}
'

import requests

url = "https://api.cool.computer/api/computers/{id}/exec"

payload = { "command": "uname -a" }
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: 'uname -a'})
};

fetch('https://api.cool.computer/api/computers/{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.cool.computer/api/computers/{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' => 'uname -a'
  ]),
  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://api.cool.computer/api/computers/{id}/exec"

	payload := strings.NewReader("{\n  \"command\": \"uname -a\"\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://api.cool.computer/api/computers/{id}/exec")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"uname -a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cool.computer/api/computers/{id}/exec")

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\": \"uname -a\"\n}"

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

{
  "execution_id": "<string>",
  "status": "succeeded",
  "stdout": "<string>",
  "stderr": "<string>",
  "exit_code": 123,
  "signal": "<string>",
  "error": "<string>",
  "dropped_bytes": 1,
  "dropped_frames": 1
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

Execution

Run a command

Runs one command inside a computer and waits for its stdout, stderr, and exit status: curl -X POST -H 'authorization: Bearer $TOKEN' -H 'content-type: application/json' --data '{"command":"uname -a"}' https://api.cool.computer/api/computers/{id}/exec. The response's execution_id names the run for attach and cancel, and a failure after the command may have started carries it in the problem's context.execution_id; a cwd must be an absolute path to an existing directory; a command that cannot start because its cwd is missing or is a file answers 400 invalid_cwd. A site with no VM answers 409 needs_vm and changes nothing; give it its own VM first with POST /api/computers/{id}/vm. To run something on a schedule, create a systemd timer with this endpoint, for example `sudo systemd-run --uid=runtime --on-calendar='*:0/15' --unit=report /home/runtime/report.sh`; the image has no cron, and timers reach the network the same way exec does.

POST

api

computers

{id}

exec

Run a command

curl --request POST \
  --url https://api.cool.computer/api/computers/{id}/exec \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "uname -a"
}
'

import requests

url = "https://api.cool.computer/api/computers/{id}/exec"

payload = { "command": "uname -a" }
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: 'uname -a'})
};

fetch('https://api.cool.computer/api/computers/{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.cool.computer/api/computers/{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' => 'uname -a'
  ]),
  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://api.cool.computer/api/computers/{id}/exec"

	payload := strings.NewReader("{\n  \"command\": \"uname -a\"\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://api.cool.computer/api/computers/{id}/exec")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"uname -a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cool.computer/api/computers/{id}/exec")

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\": \"uname -a\"\n}"

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

{
  "execution_id": "<string>",
  "status": "succeeded",
  "stdout": "<string>",
  "stderr": "<string>",
  "exit_code": 123,
  "signal": "<string>",
  "error": "<string>",
  "dropped_bytes": 1,
  "dropped_frames": 1
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 499,
  "code": "<string>",
  "detail": "<string>",
  "resolution": "<string>",
  "context": {},
  "suggestions": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

A Cool Computers API key, user access token, or claimed agent access token in the Authorization header. Follow https://www.cool.computer/auth.md for agent registration and https://www.cool.computer/authentication.md for direct user credentials.

Path Parameters

string

required

The computer's name, such as agent-atlas, or its id (cmp_…). Every caller may use either, the computer's own runtime token included.

Minimum string length: 1

Example:

"agent-atlas"

Body

application/json

command

string

required

Minimum string length: 1

execution_id

string

Optional. Omit it and the server mints one and returns it. Send your own, the computer's id followed by .exec. and 32 lowercase hex characters, when a retry must reattach to the same run instead of starting the command again.

Pattern: ^cmp_[0-9a-f]{24}\.exec\.[0-9a-f]{32}$

cwd

string

Absolute path to an existing directory; a relative one, or one missing or a file when the command fails to start, answers 400 invalid_cwd. A path through a symlink works.

uid

integer

Required range: x >= 0

gid

integer

Required range: x >= 0

shell

string | null

env

object

Show child attributes

Response

Completed command output.

execution_id

string

required

Pattern: ^cmp_[0-9a-f]{24}\.exec\.[0-9a-f]{32}$

status

enum<string>

required

Available options:

succeeded,

failed,

cancelled,

owner_lost

stdout

string

required

Retained stdout. Check dropped_bytes and dropped_frames before treating it as complete.

stderr

string

required

Retained stderr. Check dropped_bytes and dropped_frames before treating it as complete.

exit_code

integer

required

signal

string

error

string

Explicit owner or launch failure when status is owner_lost or failed.

dropped_bytes

integer

Required range: x >= 0

dropped_frames

integer

Required range: x >= 0

Start here

Connect your agent

Your computer

Use it

Build with the API

Endpoint reference

Run a command

Authorizations

Path Parameters

Body

Response