Deploy Runtype Sandbox | Runtype Documentation

Deploy a live Runtype Sandbox preview. Omitted retention preserves unlimited legacy retention; explicit retention is metered and rollout-gated. Provider sleep or loss can end availability earlier.

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

codestringRequired>=1 character

filesmap from strings to stringsOptional

languageenumOptional

Allowed values:

managedbooleanOptional

packageJsonstringOptional

portintegerOptional1-65535

retentionenumOptional

Allowed values:

sandboxIdstringOptional>=1 character

sleepPolicyobjectOptional

startCommandstringOptional

Response

Sandbox deployment result

sandboxIdstring

statusstring

effectivePolicyobjectOptional

errorstringOptional

outputstringOptional

previewUrlstringOptional

stagestringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/tools/sandbox/cf-sandbox/deploy \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"code": "string"
>	}'

1	{
2	"sandboxId": "string",
3	"status": "string",
4	"effectivePolicy": {
5	"expiresAt": "string",
6	"metering": "active",
7	"origin": "explicit",
8	"retention": "10m",
9	"autoDeleteInterval": 1.1,
10	"autoStopInterval": 1.1,
11	"sleepPolicy": {
12	"mode": "never"
13	}
14	},
15	"error": "string",
16	"output": "string",
17	"previewUrl": "string",
18	"stage": "string"
19	}