Skip to main content
POST
code.process.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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.process.start or code.sandbox.packages.install.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
maxOutputBytes
integer
default:65536

Maximum UTF-8 bytes returned per output stream.

Required range: 1 <= x <= 65536

Response

The result

status
enum<string>
required

Confirmed execution state; disappearance alone never means success.

Available options:
running,
completed,
failed,
timed_out
stdout
string

Bounded standard output.

stderr
string

Bounded standard error.

exitCode
integer

Observed exit code.

Required range: 0 <= x <= 255
truncated
boolean

Output exceeded a returned limit.

installed
object[]

Installed packages after a successful install.