Start sandbox background command

curl --request POST \
  --url https://api.veryfront.com/sandboxes/{sandbox_id}/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "cwd": "<string>",
  "timeout_seconds": 600,
  "env": {}
}
'

import requests

url = "https://api.veryfront.com/sandboxes/{sandbox_id}/commands"

payload = {
    "command": "<string>",
    "cwd": "<string>",
    "timeout_seconds": 600,
    "env": {}
}
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: '<string>', cwd: '<string>', timeout_seconds: 600, env: {}})
};

fetch('https://api.veryfront.com/sandboxes/{sandbox_id}/commands', 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.veryfront.com/sandboxes/{sandbox_id}/commands",
  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>',
    'cwd' => '<string>',
    'timeout_seconds' => 600,
    'env' => [
        
    ]
  ]),
  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.veryfront.com/sandboxes/{sandbox_id}/commands"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeout_seconds\": 600,\n  \"env\": {}\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.veryfront.com/sandboxes/{sandbox_id}/commands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeout_seconds\": 600,\n  \"env\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.veryfront.com/sandboxes/{sandbox_id}/commands")

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\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeout_seconds\": 600,\n  \"env\": {}\n}"

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

{
  "command_id": "<string>",
  "command": "<string>",
  "signal": "<string>",
  "heartbeat_status": "disabled",
  "last_heartbeat_at": "<string>",
  "last_heartbeat_error": "<string>",
  "heartbeat_failure_count": 1,
  "status": "pending",
  "exit_code": 123,
  "started_at": "<string>",
  "finished_at": "<string>"
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

POST

sandboxes

{sandbox_id}

commands

Start sandbox background command

curl --request POST \
  --url https://api.veryfront.com/sandboxes/{sandbox_id}/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "<string>",
  "cwd": "<string>",
  "timeout_seconds": 600,
  "env": {}
}
'

import requests

url = "https://api.veryfront.com/sandboxes/{sandbox_id}/commands"

payload = {
    "command": "<string>",
    "cwd": "<string>",
    "timeout_seconds": 600,
    "env": {}
}
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: '<string>', cwd: '<string>', timeout_seconds: 600, env: {}})
};

fetch('https://api.veryfront.com/sandboxes/{sandbox_id}/commands', 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.veryfront.com/sandboxes/{sandbox_id}/commands",
  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>',
    'cwd' => '<string>',
    'timeout_seconds' => 600,
    'env' => [
        
    ]
  ]),
  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.veryfront.com/sandboxes/{sandbox_id}/commands"

	payload := strings.NewReader("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeout_seconds\": 600,\n  \"env\": {}\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.veryfront.com/sandboxes/{sandbox_id}/commands")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeout_seconds\": 600,\n  \"env\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.veryfront.com/sandboxes/{sandbox_id}/commands")

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\": \"<string>\",\n  \"cwd\": \"<string>\",\n  \"timeout_seconds\": 600,\n  \"env\": {}\n}"

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

{
  "command_id": "<string>",
  "command": "<string>",
  "signal": "<string>",
  "heartbeat_status": "disabled",
  "last_heartbeat_at": "<string>",
  "last_heartbeat_error": "<string>",
  "heartbeat_failure_count": 1,
  "status": "pending",
  "exit_code": 123,
  "started_at": "<string>",
  "finished_at": "<string>"
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

{
  "type": "https://api.veryfront.com/errors/validation-failed",
  "title": "Validation Failed",
  "status": 400,
  "cause": "schedule_concurrency_forbidden",
  "idempotency": {
    "state": "in_progress",
    "operation": "<string>",
    "retryable": true,
    "retry_after_seconds": 1,
    "expires_at": "<string>",
    "recovery": {
      "available": true,
      "description": "<string>",
      "resource_url": "<string>"
    }
  },
  "code": "RUN_INVALID_INPUT",
  "detail": "The 'email' field must be a valid email address",
  "instance": "/projects/my-project/members",
  "slug": "validation-failed",
  "category": "VALIDATION",
  "suggestion": "Check the request body and query parameters against the API documentation.",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format",
      "code": "INVALID_FORMAT"
    }
  ]
}

Authorizations

Authorization

string

header

required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

sandbox_id

string<uuid>

required

Sandbox UUID.

Body

application/json

command

string

required

Minimum string length: 1

cwd

string

timeout_seconds

integer

default:600

Required range: x <= 600

env

object

Show child attributes

Response

Background command metadata, returned immediately while the command keeps running.

command_id

string

required

command

string

required

signal

string | null

required

heartbeat_status

enum<string>

required

Available options:

disabled,

healthy,

degraded

last_heartbeat_at

string | null

required

last_heartbeat_error

string | null

required

heartbeat_failure_count

integer

required

Required range: x >= 0

status

enum<string>

required

Available options:

pending,

running,

completed,

failed,

canceled

exit_code

integer | null

required

started_at

string | null

required

finished_at

string | null

required

Get started

APIs

REST API

GraphQL API

MCP API

Start sandbox background command

Authorizations

Path Parameters

Body

Response