API overview
REST API for sandbox execution and session management.
The execution API is versioned under /v1. All endpoints accept JSON and require bearer authentication.
Base URL: https://api.inis.run
Each endpoint in the reference shows the HTTP method, path, request body, and response shape. For interactive exploration, use the OpenAPI spec or the CLI.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /v1/sessions/exec | Stateless run in a throwaway session |
| GET | /v1/sessions | List sessions |
| POST | /v1/sessions | Create session |
| GET | /v1/sessions/{id} | Get session |
| DELETE | /v1/sessions/{id} | Destroy session |
| POST | /v1/sessions/{id}/exec | Run command |
| POST | /v1/sessions/{id}/processes | Start a named background process |
| GET | /v1/sessions/{id}/processes | List named background processes |
| GET/DELETE | /v1/sessions/{id}/processes/{name} | Get / kill a named background process |
| GET | /v1/sessions/{id}/processes/{name}/logs | Process output — buffered, or ?follow=true for SSE |
| GET | /v1/sessions/{id}/files | Read a file, list a directory, or ?op=find/?op=grep |
| PUT | /v1/sessions/{id}/files | Write a file |
| PUT | /v1/sessions/{id}/files/batch | Write several small files in one call |
| GET | /v1/sessions/{id}/pty | Interactive terminal (WebSocket) |
| GET | /v1/sessions/{id}/tunnel | SSH tunnel (WebSocket) |
| POST | /v1/sessions/{id}/expose | Preview URL |
| POST | /v1/sessions/{id}/unexpose | Remove exposed port |
| GET/POST | /v1/sessions/{id}/egress | Read / set the egress policy |
| POST | /v1/sessions/{id}/fork | Fork into N children |
| POST | /v1/sessions/{id}/pause | Pause session |
| POST | /v1/sessions/{id}/resume | Resume session |
| POST / GET | /v1/sessions/{id}/checkpoints | Create / list checkpoints |
| POST | /v1/sessions/{id}/restore | Roll back to a checkpoint in place |
| POST / GET | /v1/sessions/{id}/artifacts | Capture / list artifacts |
| GET | /v1/templates | List available templates |
| POST | /v1/sessions/{id}/templates | Save a session as a template |
| POST | /v1/sessions/batch/exec | Fan-out command |
| GET | /v1/org | Account capacity and limits |
| GET | /v1/healthz | Node health (no auth) |
Detail: Stateless execution · Sessions · Organisation · Errors · Networking & egress · Execution log · Artifacts · Templates
Account management (API keys, usage, billing) lives on the control plane at https://app.inis.run/v1/* — separate from execution. That's also where GET /v1/audit/events lives — see Execution log.
Sandbox sizes
Pass size on session create or execute: small, medium, or large. Omitted uses the server's default tier. See pricing for vCPU/RAM/rates.
OpenAPI
The full schema is available as openapi.yaml.
New to the primitives? Start with Concepts.