curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes' \
--header 'Authorization: ApiKey YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"command": "string",
"working_dir": "string",
"env": {},
"name": "Two-Person Tent",
"restart": "never",
"max_restarts": 1,
"restart_backoff_ms": 250,
"stdin": false,
"timeout_seconds": 250,
"log": {
"max_bytes": 4096,
"keep_rotations": 1
}
}'
Start a supervised background process
Start a supervised background process
POST
/
api
/
v1
/
sandbox
/
{id}
/
processes
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes' \
--header 'Authorization: ApiKey YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"command": "string",
"working_dir": "string",
"env": {},
"name": "Two-Person Tent",
"restart": "never",
"max_restarts": 1,
"restart_backoff_ms": 250,
"stdin": false,
"timeout_seconds": 250,
"log": {
"max_bytes": 4096,
"keep_rotations": 1
}
}'
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Path parameters
string (uuid)
required
Sandbox identifier
Request body
StartProcessRequest
string | string[]
required
Minimum length:
1. Maximum length: 100000.Show command
Show command
Show Option 1: string
Show Option 1: string
Minimum length:
1. Maximum length: 100000.Show Option 2: string[]
Show Option 2: string[]
Minimum items:
1. Maximum items: 1000.string
Minimum length:
1. Maximum length: 4096.object
Additional keys map to values of type
string.string
Minimum length:
1. Maximum length: 128.string
Allowed values:
'never', 'on-failure', 'always'. Default: 'never'.integer
Minimum:
0. Maximum: 10000.integer
Minimum:
0. Maximum: 300000.boolean
Default:
false.integer,null
Minimum:
1. Maximum: 2592000.Response
No response body. Process started.Status codes
| Code | Meaning |
|---|---|
201 | Process started |
400 | Invalid request |
404 | Sandbox not found |
429 | Too many running processes in the sandbox |
501 | The sandbox’s exec agent does not support supervised processes |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes' \
--header 'Authorization: ApiKey YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"command": "string",
"working_dir": "string",
"env": {},
"name": "Two-Person Tent",
"restart": "never",
"max_restarts": 1,
"restart_backoff_ms": 250,
"stdin": false,
"timeout_seconds": 250,
"log": {
"max_bytes": 4096,
"keep_rotations": 1
}
}'
Last modified on October 20, 2026