API Key

Getting your API Key

Create an account — Sign up at app.irisrun.io using GitHub or email.

Navigate to API Keys — Go to Settings → API Keys in your dashboard.

Create a new key — Click Create API Key and give it a descriptive name.

Copy and save — Copy your API key immediately — it won't be shown again.

Keep your API key secret. Never commit it to version control or expose it in client-side code.

export IRIS_API_KEY=iris_sk_...

The SDK automatically reads from IRIS_API_KEY:

import { Sandbox } from '@iris/sdk'

// API key is read from environment
const sandbox = await Sandbox.create()

If you need to pass the key explicitly (e.g. in tests), use IrisClient directly:

import { IrisClient } from '@iris/sdk'

const client = new IrisClient({ apiKey: 'iris_sk_...' })
const sandbox = await client.sandboxes.create()

Permission	Description
`sandbox:create`	Create new sandboxes
`sandbox:exec`	Execute commands in sandboxes
`sandbox:checkpoint`	Create checkpoints
`sandbox:restore`	Restore from checkpoints
`sandbox:delete`	Delete sandboxes and checkpoints