Skip to main content
POST
code.process.start

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by code.sandbox.create or code.sandbox.create-configured.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
command
string
required

Executable name or path; arguments are supplied separately.

Required string length: 1 - 1024
arguments
string[]

Up to 128 literal arguments.

Maximum array length: 128

One literal argument.

Maximum string length: 4096
cwd
string

Sandbox path, at most 1,024 UTF-8 bytes; no parent traversal or control characters.

Required string length: 1 - 1024
environment
object

Non-secret application variables, up to 64 entries and 16,384 UTF-8 bytes. Do not include credentials.

timeoutSeconds
integer
default:300

Stop after this many seconds; must fit the remaining paid lease.

Required range: 1 <= x <= 1800

Response

The result

status
enum<string>
required

Process state immediately after submission.

Available options:
running,
completed
ref
string

Reference to what this call created. Pass it as ref to code.process.get or code.process.stop.