Skip to main content
POST
Creates a new cloud session backed by a sandbox environment. The session starts in a pending state and transitions to active once the sandbox is provisioned. Required scope: sessions:write

Headers

string
required
Bearer token. Example: Bearer runtm_xxx
string
Scope the session to an organization.

Body

string
required
Coding agent to use: claude-code, codex, cursor, gemini, etc.
string
Template ID to initialize the session from.
string
Roster agent UUID to run the session as. Applies the agent’s system instructions, tags the session with its identity, and fills in its default template and harness when you don’t pass them — the same overlay a Slack or Linear trigger gets. Subject to the agent’s callable_by allowlist; see Trigger a subagent.
string
An approved approval on the calling session, when the callee’s caller edge requires one.
string
Display name for the session.
string
default:"private"
Session visibility: private or team.
object
Key-value pairs of environment variables to inject into the sandbox.

Response

Returns 201 with the created session object.
string
Session ID (e.g. ses_abc123).
string
Display name.
string
Session state: active, paused, or destroyed.
string
Coding agent assigned to the session.
string | null
Template used to initialize the session.
string
URL of the sandbox environment.
string
Session visibility.
string
Owner user ID.
string | null
Organization the session belongs to.
string
ISO 8601 creation timestamp.
string | null
ISO 8601 last update timestamp.