Execute code in the sandbox) Code Interpreter

Stages files into a fresh workspace, runs the entry point under NsJail with the configured limits, and returns the captured output plus refs to any files the run produced.

Concurrency is bounded by SANDBOX_MAX_CONCURRENT_JOBS. The request body is capped by SANDBOX_EXECUTE_BODY_LIMIT (50 MB by default).

Header Parameters

X-CodeAPI-Execution-Manifest?string

Header form of execution_manifest, for rolling upgrades.

X-CodeAPI-Egress-Grant?string

Header form of egress_grant, for rolling upgrades.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

language*string

Runtime language, matched against the discovered runtimes.

version*string

Semver range selecting a runtime version. The newest installed runtime matching the range wins.

files*array<>

Items1 <= items

session_id?string

Top-level execution session id for one sandbox invocation.

output_session_id?string

Storage session that generated files are uploaded to.

args?array<string>

stdin?string

run_timeout?integer

Wall-clock run limit in ms. Defaults to SANDBOX_RUN_TIMEOUT.

compile_timeout?integer

Compile-phase limit in ms. Defaults to SANDBOX_COMPILE_TIMEOUT.

run_cpu_time?integer

CPU-time limit for the run phase, in ms.

compile_cpu_time?integer

CPU-time limit for the compile phase, in ms.

run_memory_limit?integer

Run-phase memory cgroup limit in bytes; -1 for no limit.

compile_memory_limit?integer

Compile-phase memory cgroup limit in bytes; -1 for no limit.

env_vars?

Extra environment variables. Keys must match ^[A-Z_][A-Z0-9_]*$ (case-insensitive); non-conforming keys are dropped. The combined key and value bytes may not exceed 1,000,000.

tool_call_socket?boolean

Requests a tool-call socket inside the sandbox. Granted only when the execution manifest authorizes it and is body-bound; otherwise the request is rejected with a scope mismatch.

egress_grant?string

Encrypted egress capability. Also accepted as X-CodeAPI-Egress-Grant.

execution_manifest?string

Signed execution manifest. Also accepted as X-CodeAPI-Execution-Manifest. Required when SANDBOX_REQUIRE_EGRESS_MANIFEST=true (the default).

persist_session?

Persistent-session marker, set by the service only when CODEAPI_PERSIST_SESSIONS=true. Instructs the runner to restore a prior workspace tar before the run and snapshot /mnt/data back afterwards. Covered by the manifest body hash like every other field.

dependencies?

Per-job packages installed before user code runs, wheels only. Rejected unless CODEAPI_ALLOW_DYNAMIC_DEPENDENCIES=true.

Response Body

`application/json`

curl -X POST "https://example.com/execute" \  -H "Content-Type: application/json" \  -d '{    "language": "python",    "version": "3.14.4",    "files": [      {        "name": "main.py",        "content": "print(42)"      }    ]  }'

{  "session_id": "string",  "stdout": "string",  "stderr": "string",  "files": [    {      "id": "string",      "name": "string",      "storage_session_id": "string",      "modified_from": {        "id": "string",        "storage_session_id": "string"      },      "inherited": true,      "entity_id": "string"    }  ],  "code": 0,  "signal": "string",  "message": "string",  "status": "string",  "wall_time": 0,  "session_state_persisted": true,  "session_state_restore_failed": true}

Execute code in the sandbox

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

415application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`