Skip to main content
POST
code.sandbox.packages.install

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})$
manager
enum<string>
required

Package registry manager.

Available options:
npm,
pip
packages
string[]
required

1–50 registry packages.

Required array length: 1 - 50 elements

Registry package name with optional version; URL, git and path sources are refused.

Required string length: 1 - 256
timeoutSeconds
integer
default:300

Install deadline, bounded by the paid lease.

Required range: 1 <= x <= 300

Response

The result

status
enum<string>
required

Background installation state; reading the process reference returns logs and installed packages.

Available options:
running,
completed
ref
string

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