# Runtime - [Introduction](https://docs.runtm.com/introduction.md): What Runtime is and what an agent is made of: a job, a success measure, tools, a way of working, and a feedback loop. Read first, then go to Quickstart to build one. - [Quickstart: build your first agent](https://docs.runtm.com/quickstart.md): Go from a new organization to a roster agent with a template, one evaluation category, one trigger and a graded run. Read this first; it introduces the dashboard flow and the runtm-api CLI. - [MCP server](https://docs.runtm.com/mcp/overview.md): Connect Claude, ChatGPT, Grok Bot, Cursor, VS Code or Codex to Runtime with one URL, https://mcp.runtm.com/mcp. Copy-paste install for each client, sign-in with OAuth or an API key, and what the server can do. Read before connecting an AI client to Runtime. - [MCP authentication](https://docs.runtm.com/mcp/authentication.md): How AI clients sign in to the Runtime MCP server: OAuth with your Runtime login or SSO, the workspace and consent screens, the scopes a connected app gets, and API keys as bearer tokens. Read when connecting a client, choosing a workspace, or limiting what a connected app can do. - [MCP tools](https://docs.runtm.com/mcp/tools.md): Every tool the Runtime MCP server exposes, grouped by toolset, with inputs, what each tool does and the API page behind it. Covers ?toolsets= and ?mode=tools for gateways, update semantics with clear, and the dashboard-link handoffs. Read when choosing toolsets or calling a Runtime MCP tool. - [Okta and the MCP server](https://docs.runtm.com/mcp/okta.md): Two ways Okta works with Runtime MCP: people sign in to the Runtime MCP server through your Okta SSO, and org admins give an Okta-protected MCP server its own OAuth app (Okta domain plus authorization server ID) so agents can connect to it. Read when your company uses Okta. - [MCP troubleshooting](https://docs.runtm.com/mcp/troubleshooting.md): Fix common Runtime MCP server problems: the browser shows docs instead of tools, 401 invalid_token, 403 after sign-in, missing tools, unknown toolset, rate limits, timeouts and the wrong workspace. Read when a client can't connect to https://mcp.runtm.com/mcp or a tool call fails. - [Build an agent](https://docs.runtm.com/build/overview.md): The six steps that build a Runtime agent in the right order: define the job, measure success, give it tools, define how it works, prove it on seeded cases, then add guardrails. Start here before creating or changing any agent, and read the order before adding a single guardrail. - [1. Define the job](https://docs.runtm.com/build/define-the-job.md): Create a roster agent with a name, description, system instructions, default template and coding agent, and write an objective that states input, output and boundary. Read before `runtm-api agents create` or the Agents > New Agent dialog. - [2. Measure success](https://docs.runtm.com/build/measure-success.md): Add evaluation categories (when a run belongs, how to grade it pass or fail, what a human would spend), set a monthly budget, and read the scorecard. Read before `runtm-api agents update --evaluator-criteria` or the Performance evaluation section. - [3. Give it tools](https://docs.runtm.com/build/give-it-tools.md): Attach tool providers, MCP servers, secrets and repos to the template an agent runs on, and understand which of them a session actually receives. Covers choosing CLI, then SDK, then API, then browser for reaching a vendor, and handing the person a /connect link so credentials go to Runtime and never… - [4. Define how it works](https://docs.runtm.com/build/how-it-works/overview.md): The three things that decide how an agent behaves once it has a job and tools: the runbook it follows (skills), the instructions it reads, and the triggers that start it. Read before attaching skills or connecting a trigger; guardrails come later, in step 6, after the agent has proven it can do the… - [Skills and runbooks](https://docs.runtm.com/build/how-it-works/skills.md): Write the runbook an agent follows as a skill (SKILL.md plus reference files), require the tools it needs, and attach it to a template, which rebuilds by itself. Read before `runtm-api skills create`, `skills import` or `skills attach`. - [Instructions](https://docs.runtm.com/build/how-it-works/instructions.md): Understand the nine instruction layers written into every session, which layer wins, and where to put agent role, org policy, template facts and personal preferences. Read before `runtm-api agents update --instructions`, `runtm-api instructions set` or `runtm-api template context set`. - [Triggers](https://docs.runtm.com/build/how-it-works/triggers.md): Connect an agent to Slack, Linear, GitHub, Email, WhatsApp, SMS, a cron schedule, or the API, and understand what each trigger sends and how it replies. Read before `runtm-api agents create --type` or `runtm-api scheduled-agents create`. - [5. Prove it works and iterate](https://docs.runtm.com/build/launch-and-iterate.md): Prove the agent can do the job before you constrain it: check the template carries its skills and tools, run seeded cases with read-only credentials, read the grade and the scorecard, then tighten the rubric and runbook. Read before the first run, before adding any guardrail, and whenever `runtm-api… - [6. Add guardrails and approvals](https://docs.runtm.com/build/guardrails-and-approvals.md): Once the agent has passed its seeded cases, restrict what it can run, reach, and change with allowlist rules, hooks, network rules and org limits, and gate sensitive actions behind a human approval requested from inside the run. Read before `runtm-api guardrails rules|hooks|network create`, `runtm-a… - [Sessions](https://docs.runtm.com/concepts/sessions.md): What a session is (the sandbox an agent run happens in), its states, auto-pause and heartbeats, and how sessions relate to roster agents. Read when a run is paused, missing, or you need the session object itself. - [Coding Agents](https://docs.runtm.com/concepts/coding-agents.md): The coding agents (harnesses) that execute a run: Claude Code, Codex, OpenCode, Cline, GitHub Copilot, plus the interactive-only Cursor, Devin and Gemini, with models and capabilities. Read when choosing or changing the coding agent on a template or roster agent. - [Templates](https://docs.runtm.com/concepts/templates.md): What a template is (the environment and capability container an agent runs on), what gets baked into its snapshot, builds and rebuilds, snapshots from sessions, secrets and permissions. Read when a session boots without what you attached. - [Context](https://docs.runtm.com/concepts/context.md): The context layers every session receives: instructions (org, user, template), skills, MCP servers, docs and knowledge sources, and the boot order they are applied in. Read when an agent ignores an instruction or cannot see a tool. - [Skills](https://docs.runtm.com/concepts/skills.md): Reference for skills as stored objects: the SKILL.md bundle, reference files, MCP and tooling declarations, directive types, the single-live-version and lock model, import, discover and resync. Read when authoring or importing a skill; the Build page covers the workflow. - [Guardrails](https://docs.runtm.com/concepts/guardrails.md): Reference for allowlists, hooks, network rules, approvals, RBAC and audit: what each governs, dispositions and precedence, hook events, and a typical org configuration. Read when a command was blocked or you need to know which layer enforces what. - [Deployments](https://docs.runtm.com/concepts/deployments.md): How a session ships to a live URL: the scaffold, validate, preflight and run pipeline, project types, the runtm.yaml manifest, build logs and volumes. Read when an agent must deploy the app it produced. - [Integrations](https://docs.runtm.com/concepts/integrations.md): Reference for the org-level integrations that start runs and carry results back: GitHub App and user tokens, Linear and Slack, and the permissions around them. Read when connecting one of these systems; the Build Triggers page covers how each one starts an agent. For credentials an agent uses during… - [Tools and connections](https://docs.runtm.com/concepts/tools.md): Reference for tools an agent uses during a run: tool providers (formerly knowledge sources) and MCP servers, and the connections that hold their credentials. Explains provider vs connection vs attachment, why connections should be agent-scoped by default, how a run picks a connection, and how a pers… - [Organizations](https://docs.runtm.com/concepts/organizations.md): Personal versus organization mode, the three roles and how they cap API-key scopes, org-scoped keys, and which resources are org-scoped. Read when a call returns 403 or a resource is missing from a list. - [Observability](https://docs.runtm.com/concepts/observability.md): Activity, metrics, traces and cost tracking for every run, and how to export them. Read when you need to see what an agent did and what it cost; grades and the scorecard are on Measure success. - [Real-time](https://docs.runtm.com/concepts/real-time.md): The three WebSocket channels (terminal, prompt streaming, collaboration), the token exchange, frame formats, and when to use REST instead. Read when building a live UI or streaming a run. - [Guides](https://docs.runtm.com/guides/overview.md): Worked agents for payments operations (support, fraud and risk review, merchant underwriting) built end to end in the six Build steps, plus short recipes for one task each. Read when you want a working agent to copy rather than the method. - [Payment support agent](https://docs.runtm.com/guides/payments/support-agent.md): Build an agent that takes a Slack question or a forwarded Zendesk ticket about a charge, decline or refund, reconstructs the payment timeline from Stripe and a read-only ledger, and drafts a cited customer reply behind an approval gate. Uses Zendesk, a custom Stripe provider and Postgres. Read when… - [Fraud and risk review agent](https://docs.runtm.com/guides/payments/fraud-risk-agent.md): Build a scheduled agent that sweeps new Stripe Radar reviews and velocity alerts every 30 minutes, assembles a review packet from Stripe, BigQuery and a read-only Postgres, posts it to Slack, and leaves every block to a human. Read this when you want an unattended risk agent with an agent-scoped Str… - [Merchant underwriting agent](https://docs.runtm.com/guides/payments/underwriting-agent.md): Build an agent that assembles a decision memo for a pending merchant application from a KYB provider (Middesk), the applications database and the underwriting policy in Notion, without ever changing an application's status. A complete worked example in the six-step order: job, rubric, tools (custom… - [Multi-agent: underwriting re-review with two approval gates](https://docs.runtm.com/guides/payments/multi-agent-underwriting.md): Build a three-agent system: an Underwriting Agent triggered by a Slack alert that delegates research to a Risk Agent and, only on escalation, delegates a merchant block to an Engineering Agent, with a human approval before each handoff. Shows how subagents are triggered, attributed, gated and graded… - [Connect Stripe with a restricted read-only key](https://docs.runtm.com/guides/recipes/connect-stripe-read-only.md): Create Stripe as a custom tool provider, connect it to one agent with a restricted key that can only read, and make a skill require it. Read when an agent needs charges, payment intents, refunds or disputes and must never move money. - [Add a KYB provider as a custom tool provider](https://docs.runtm.com/guides/recipes/add-kyb-provider.md): Define a know-your-business vendor such as Middesk, Persona or Alloy as a custom tool provider, connect it to one agent only, and require it from the agent's skill. Read when an underwriting or onboarding agent needs verification data that is not in the built-in catalog. - [Add an MCP server with an API-token connection](https://docs.runtm.com/guides/recipes/add-mcp-server-with-token.md): Define a stdio MCP server as a directive, supply its API token through a separate connection so the secret never enters the template snapshot, attach it to a template, which rebuilds by itself. Read when a vendor ships an MCP server and you want the agent limited to its typed tools. - [Route one Linear team to a different template](https://docs.runtm.com/guides/recipes/route-linear-team-to-template.md): Send issues from one Linear team to a different template than the agent's default so that team's runs get their own repo, tools and skills. Read when one agent serves several teams and one of them needs a different environment. - [Test a scheduled agent before enabling it](https://docs.runtm.com/guides/recipes/test-scheduled-agent-before-enabling.md): Create a scheduled agent disabled, run it once on demand, read the session, then enable the schedule, so a misconfiguration fails in front of you rather than at 03:00 UTC. Read before enabling any cron-driven agent. - [Request an approval from inside a run](https://docs.runtm.com/guides/recipes/request-approval-from-a-run.md): Make an agent stop at one step of its runbook and wait for a human to approve or reject before it continues, using the runtm-approval helper inside the sandbox. Read when a runbook reaches a customer-facing send, a refund, or a status change. - [Delegate work to another agent](https://docs.runtm.com/guides/recipes/delegate-to-another-agent.md): Let one Runtime agent hand a task to another: a delegate script that creates the subagent's session attributed to its roster agent and forwards the prompt, a PreToolUse hook that turns every handoff into a human approval, and the two-line command the dashboard recognises. Read when building an orche… - [Give an agent persistent memory in Notion or Confluence](https://docs.runtm.com/guides/recipes/agent-memory-in-notion-or-confluence.md): Connect Notion or Confluence to one agent and make a playbook page and a memory page its source of truth, so every run reads what earlier runs learned and writes back what it learned. Read when an agent should remember across sessions, or when your team already keeps playbooks in a wiki. - [Share an app's data across sessions](https://docs.runtm.com/guides/recipes/share-data-across-sessions.md): Turn on Shared database for a template and copy lake.js into your app, so every session of that template reads and writes the same data. Read when an app built in a session needs saved state that teammates and later sessions see: a tracker, a dashboard, a small internal tool. - [Agent that opens a PR on your GitHub repo](https://docs.runtm.com/guides/recipes/repo-agent-opens-prs.md): Turn a GitHub repo into a template, keep it current with an hourly scheduled rebuild and a startup script pull, and give an agent a prompt that commits a change and opens a pull request. Read when you want each session to start on the latest main and end with a PR. - [API Overview](https://docs.runtm.com/cloud-api/overview.md): Programmatic access to Runtime Cloud sessions, deployments, templates, and integrations - [Agent CLI (runtm-api)](https://docs.runtm.com/cloud-api/agent-cli.md): The runtm-api CLI that coding agents use to operate Runtime: install, auth and org context, the command table, output and exit-code contract, error recovery, which command carries which capability, the assembly order that avoids silent failures, and trigger preflight. Read before running any runtm-a… - [Authentication](https://docs.runtm.com/cloud-api/authentication.md): How to authenticate with the Runtime Cloud API - [Verify API Key](https://docs.runtm.com/cloud-api/authentication/verify.md): Verify an API key and inspect its scopes - [Scopes & Permissions](https://docs.runtm.com/cloud-api/scopes.md): API key scopes, what each unlocks, the scope every runtm-api command needs, presets, and role ceilings. Read when a call returns 403 or before creating a key for an agent. - [Errors](https://docs.runtm.com/cloud-api/errors.md): Error response shape, every status code the API returns and what to do about each, including the scheduled-agent 502 and 503 cases, plus rate-limit headers. Read when a call fails. - [Rate Limits](https://docs.runtm.com/cloud-api/rate-limits.md): API rate limiting and throttling - [Conventions](https://docs.runtm.com/cloud-api/conventions.md): Common patterns across all endpoints - [Authenticate and manage API keys](https://docs.runtm.com/cloud-api/patterns/authentication.md): Create, verify, scope, rotate, and revoke API keys for the Runtime API - [Manage sessions at scale](https://docs.runtm.com/cloud-api/patterns/sessions-at-scale.md): Session lifecycle, polling, heartbeats, retries, and error recovery - [Stream prompts over WebSockets](https://docs.runtm.com/cloud-api/patterns/streaming-prompts.md): Token exchange, the Prompt WebSocket protocol, event types, and reconnection handling - [Work with session files](https://docs.runtm.com/cloud-api/patterns/session-files.md): Read, write, upload, download, and search files inside a running sandbox - [Handle long-running prompts](https://docs.runtm.com/cloud-api/patterns/long-running-prompts.md): Cancel, rewind, replay history, and choose between REST and WebSocket for prompt control - [Pull activity and telemetry](https://docs.runtm.com/cloud-api/patterns/activity-and-telemetry.md): Read personal and team activity, usage summaries, traces, and per-session cost data - [Outbound webhooks](https://docs.runtm.com/cloud-api/patterns/outbound-webhooks.md): The two outbound webhook events Runtime emits (prompt.completed, prompt.timed_out), their payload, delivery guarantees, and a minimal receiver. Read when wiring Runtime into an external system; for inbound triggers see Build > Triggers. - [Work a session from the CLI](https://docs.runtm.com/cloud-api/patterns/session-cli-recipes.md): Boot a session from a template, run commands with connect or exec, hot-load skills and MCP, move files, share previews, deploy, pause and resume, all with runtm-api. Read when a coding agent must drive a session end to end from the terminal. - [Trigger a subagent](https://docs.runtm.com/cloud-api/patterns/subagents.md): Launch a session as one of your agents — from the CLI, the API, or from inside another agent's run - [Debug a session](https://docs.runtm.com/cloud-api/patterns/debug-a-session.md): Identify a session, capture its state in one pass, read files and live events, interpret the common failure modes, and take corrective action or escalate. Read when a run stalled, errored, or produced nothing. - [Template lifecycle from the CLI](https://docs.runtm.com/cloud-api/patterns/template-lifecycle.md): Discover, create, build, verify, fix, snapshot and rebuild org templates with runtm-api, including session arguments, owning groups, auto-rebuild, template secrets, context and guardrails resolution, and the automatic rebuild that attaching a skill or MCP server queues. Read when a coding agent must… - [List Sessions](https://docs.runtm.com/cloud-api/sessions/list.md): List cloud sessions with pagination and filters - [Search Sessions](https://docs.runtm.com/cloud-api/sessions/search.md): Fuzzy-search sessions with filters - [Create Session](https://docs.runtm.com/cloud-api/sessions/create.md): Create a new cloud session with a coding agent - [Get Session](https://docs.runtm.com/cloud-api/sessions/get.md): Retrieve a single cloud session by ID - [Delete Session](https://docs.runtm.com/cloud-api/sessions/delete.md): Destroy a session and its sandbox - [Rename Session](https://docs.runtm.com/cloud-api/sessions/rename.md): Update the display name of a session - [Update Visibility](https://docs.runtm.com/cloud-api/sessions/visibility.md): Change a session's visibility between private and team - [Share a Preview](https://docs.runtm.com/cloud-api/sessions/preview-shares-create.md): Give someone outside your organization access to one port of a session's live preview - [List Preview Shares](https://docs.runtm.com/cloud-api/sessions/preview-shares-list.md): See who has access to a session's live preview - [Revoke a Preview Share](https://docs.runtm.com/cloud-api/sessions/preview-shares-revoke.md): Withdraw someone's access to a shared preview - [Pause Session](https://docs.runtm.com/cloud-api/sessions/pause.md): Pause a session to save resources - [Resume Session](https://docs.runtm.com/cloud-api/sessions/resume.md): Resume a paused session - [Start Session (legacy)](https://docs.runtm.com/cloud-api/sessions/start.md): Legacy cold-start endpoint - prefer the v2 sandbox lifecycle endpoint - [Heartbeat (legacy)](https://docs.runtm.com/cloud-api/sessions/heartbeat.md): Legacy keepalive endpoint - prefer the v2 refresh endpoint - [Get Workspace State](https://docs.runtm.com/cloud-api/sessions/workspace-state.md): Retrieve workspace state including detected ports and processes - [List Collaborators](https://docs.runtm.com/cloud-api/sessions/collaborators.md): List users collaborating on a session - [Send Prompt](https://docs.runtm.com/cloud-api/sessions/prompt.md): Send a prompt to the coding agent in the session - [Cancel Prompt](https://docs.runtm.com/cloud-api/sessions/prompt-cancel.md): Cancel a running prompt - [Rewind Prompt](https://docs.runtm.com/cloud-api/sessions/prompt-rewind.md): Undo the last prompt and its changes - [Get History](https://docs.runtm.com/cloud-api/sessions/history.md): Retrieve prompt history for a session - [Session Events](https://docs.runtm.com/cloud-api/sessions/events.md): Subscribe to real-time session events via SSE - [List Files](https://docs.runtm.com/cloud-api/sessions/files-list.md): List files and directories in the session sandbox - [Read File](https://docs.runtm.com/cloud-api/sessions/files-read.md): Read the contents of a file in the sandbox - [Write File](https://docs.runtm.com/cloud-api/sessions/files-write.md): Create or overwrite a file in the sandbox - [Delete File](https://docs.runtm.com/cloud-api/sessions/files-delete.md): Delete a file from the sandbox - [Rename File](https://docs.runtm.com/cloud-api/sessions/files-rename.md): Rename or move a file within the sandbox - [Create Directory](https://docs.runtm.com/cloud-api/sessions/files-mkdir.md): Create a directory in the sandbox - [Search Files](https://docs.runtm.com/cloud-api/sessions/files-search.md): Search for files by content in the sandbox - [Upload File](https://docs.runtm.com/cloud-api/sessions/files-upload.md): Upload a file to the sandbox via multipart form - [Download File](https://docs.runtm.com/cloud-api/sessions/files-download.md): Download raw file content from the sandbox - [Run Server](https://docs.runtm.com/cloud-api/sessions/run-server.md): Start a development server in the sandbox - [Get Env Vars](https://docs.runtm.com/cloud-api/sessions/env-vars-get.md): Retrieve environment variables for a session - [Set Env Vars](https://docs.runtm.com/cloud-api/sessions/env-vars-set.md): Set environment variables for a session - [Delete Env Var](https://docs.runtm.com/cloud-api/sessions/env-vars-delete.md): Remove a single environment variable from a session - [Get Detected Env Vars](https://docs.runtm.com/cloud-api/sessions/detected-env-vars.md): Retrieve env vars detected from project files - [Detect Env Vars](https://docs.runtm.com/cloud-api/sessions/detect-env-vars.md): Scan the project for required environment variables - [Get Session Instructions](https://docs.runtm.com/cloud-api/sessions/instructions-get.md): Retrieve per-session custom instructions - [Set Session Instructions](https://docs.runtm.com/cloud-api/sessions/instructions-set.md): Set or update per-session custom instructions - [Clone Repository](https://docs.runtm.com/cloud-api/sessions/git-clone.md): Clone a git repository into the sandbox - [Git Operation](https://docs.runtm.com/cloud-api/sessions/git-operation.md): Execute a git operation in the sandbox - [Git Sync](https://docs.runtm.com/cloud-api/sessions/git-sync.md): Sync local changes with the remote repository - [List Approvals](https://docs.runtm.com/cloud-api/sessions/approvals-list.md): List a session's approval requests, newest first - [Resolve Approval](https://docs.runtm.com/cloud-api/sessions/approvals-resolve.md): Approve or reject a pending approval - [Load Skills](https://docs.runtm.com/cloud-api/sessions/load-skills.md): Hot-load org skills into a running session - [Load MCP Servers](https://docs.runtm.com/cloud-api/sessions/load-mcps.md): Hot-load MCP servers into a running session - [List Session Tools](https://docs.runtm.com/cloud-api/sessions/tools-list.md): The tools loaded into a session - [Load Tools](https://docs.runtm.com/cloud-api/sessions/load-tools.md): Hot-load tools into a running session - [Deploy Info](https://docs.runtm.com/cloud-api/deploy/info.md): Get current deployment status and tier recommendation for a session - [Scaffold Deploy](https://docs.runtm.com/cloud-api/deploy/scaffold.md): Generate deployment config files for the session project - [Validate Deploy](https://docs.runtm.com/cloud-api/deploy/validate.md): Validate deployment configuration before deploying - [Deploy Preflight](https://docs.runtm.com/cloud-api/deploy/preflight.md): Run pre-deploy connectivity and credential checks - [Run Deploy](https://docs.runtm.com/cloud-api/deploy/run.md): Start a deployment and stream progress events - [Get Volumes](https://docs.runtm.com/cloud-api/deploy/volumes-get.md): Get persistent volume configuration for a session - [Update Volumes](https://docs.runtm.com/cloud-api/deploy/volumes-update.md): Update persistent volume configuration for a session - [List Templates](https://docs.runtm.com/cloud-api/templates/list.md): List organization templates with pagination - [Template Repos](https://docs.runtm.com/cloud-api/templates/repos.md): List repositories available for template creation - [Get Template](https://docs.runtm.com/cloud-api/templates/get.md): Get detailed information about a specific template - [Create Template](https://docs.runtm.com/cloud-api/templates/create.md): Create a new organization template - [Update Template Config](https://docs.runtm.com/cloud-api/templates/update-config.md): Partially update a template's configuration - [Delete Template](https://docs.runtm.com/cloud-api/templates/delete.md): Delete an organization template - [Build Template](https://docs.runtm.com/cloud-api/templates/build.md): Trigger a template snapshot build - [Build Logs](https://docs.runtm.com/cloud-api/templates/build-logs.md): Stream current build logs via Server-Sent Events - [Build Logs History](https://docs.runtm.com/cloud-api/templates/build-logs-history.md): Get past build log entries for a template - [Fix Session](https://docs.runtm.com/cloud-api/templates/fix-session.md): Create a session to repair a broken template - [Save Snapshot](https://docs.runtm.com/cloud-api/templates/save-snapshot.md): Save current session state as a template snapshot - [List Template Secrets](https://docs.runtm.com/cloud-api/templates/secrets-list.md): List secret names configured for a template - [Update Template Secrets](https://docs.runtm.com/cloud-api/templates/secrets-update.md): Set or update secrets for a template - [Delete Template Secret](https://docs.runtm.com/cloud-api/templates/secret-delete.md): Delete a single secret from a template - [Get Template Context](https://docs.runtm.com/cloud-api/templates/context-get.md): Read the template's instruction block - [Set Template Context](https://docs.runtm.com/cloud-api/templates/context-set.md): Replace or clear the template's instruction block - [Resolve Template Context](https://docs.runtm.com/cloud-api/templates/context-resolve.md): The effective instruction stack a session receives - [List Template Guardrails](https://docs.runtm.com/cloud-api/templates/guardrails-list.md): List guardrails scoped to one template - [Create Template Guardrail](https://docs.runtm.com/cloud-api/templates/guardrails-create.md): Add a guardrail scoped to one template - [Update Template Guardrail](https://docs.runtm.com/cloud-api/templates/guardrails-update.md): Edit a template guardrail; omitted fields are left unchanged - [Delete Template Guardrail](https://docs.runtm.com/cloud-api/templates/guardrails-delete.md): Remove a template guardrail - [Resolve Template Guardrails](https://docs.runtm.com/cloud-api/templates/guardrails-resolve.md): The merged org and template guardrail set sessions actually enforce - [Scheduled Agents](https://docs.runtm.com/cloud-api/scheduled-agents/overview.md): Run an agent prompt on a cron schedule, and trigger a run on demand - [List Scheduled Agents](https://docs.runtm.com/cloud-api/scheduled-agents/list.md): List the organization's scheduled agents with next_run_at - [Get Scheduled Agent](https://docs.runtm.com/cloud-api/scheduled-agents/get.md): Get one scheduled agent - [Create Scheduled Agent](https://docs.runtm.com/cloud-api/scheduled-agents/create.md): Create a cron-driven agent - [Update Scheduled Agent](https://docs.runtm.com/cloud-api/scheduled-agents/update.md): Edit a scheduled agent; omitted fields are left unchanged - [Run Scheduled Agent Now](https://docs.runtm.com/cloud-api/scheduled-agents/run.md): Fire one run immediately instead of waiting for the next cron tick - [Delete Scheduled Agent](https://docs.runtm.com/cloud-api/scheduled-agents/delete.md): Permanently delete a scheduled agent and its schedule - [Agents](https://docs.runtm.com/cloud-api/agents/overview.md): Named agents with identity, instructions, session defaults, an evaluation rubric, and a budget - [List Agents](https://docs.runtm.com/cloud-api/agents/list.md): List the organization's roster agents - [Get Agent](https://docs.runtm.com/cloud-api/agents/get.md): Get one roster agent - [Create Agent](https://docs.runtm.com/cloud-api/agents/create.md): Create a roster agent - [Update Agent](https://docs.runtm.com/cloud-api/agents/update.md): Edit a roster agent; omitted fields are left unchanged - [Delete Agent](https://docs.runtm.com/cloud-api/agents/delete.md): Remove a roster agent - [List Trigger Credentials](https://docs.runtm.com/cloud-api/agents/trigger-credentials.md): Referencable agent trigger tokens (metadata only, never the secret) - [Group Usage](https://docs.runtm.com/cloud-api/groups/usage.md): What an owning group owns - [List Deployments](https://docs.runtm.com/cloud-api/deployments/list.md): List the deployments created from sessions - [Get Deployment](https://docs.runtm.com/cloud-api/deployments/get.md): Get one deployment - [Deployment Logs](https://docs.runtm.com/cloud-api/deployments/logs.md): Fetch stored build, deploy, and runtime logs - [Destroy Deployment](https://docs.runtm.com/cloud-api/deployments/destroy.md): Tear down a deployment and take its URL offline - [Resolved Secrets](https://docs.runtm.com/cloud-api/secrets/resolved.md): Get merged secret names from personal and team sources - [List Personal Secrets](https://docs.runtm.com/cloud-api/secrets/personal-list.md): List personal secret names and metadata - [Set Personal Secret](https://docs.runtm.com/cloud-api/secrets/personal-set.md): Create or update personal secrets - [Delete Personal Secret](https://docs.runtm.com/cloud-api/secrets/personal-delete.md): Delete a personal secret by name - [List Team Secrets](https://docs.runtm.com/cloud-api/secrets/team-list.md): List team secret names for the organization - [Set Team Secret](https://docs.runtm.com/cloud-api/secrets/team-set.md): Create or update team secrets for the organization - [Delete Team Secret](https://docs.runtm.com/cloud-api/secrets/team-delete.md): Delete a team secret by name - [Get User Instructions](https://docs.runtm.com/cloud-api/context/user-instructions-get.md): Retrieve the custom instructions set by the authenticated user. - [Set User Instructions](https://docs.runtm.com/cloud-api/context/user-instructions-set.md): Set or clear the custom instructions for the authenticated user. - [Get Org Instructions](https://docs.runtm.com/cloud-api/context/org-instructions-get.md): Retrieve the custom instructions set for an organization. - [Set Org Instructions](https://docs.runtm.com/cloud-api/context/org-instructions-set.md): Set or clear the custom instructions for an organization. - [List Skills](https://docs.runtm.com/cloud-api/context/skills/list.md): List skills, MCP servers, docs, hooks, and other agent directives - [Create Skill](https://docs.runtm.com/cloud-api/context/skills/create.md): Create a new agent directive (skill, MCP server, doc, hook, etc.) - [Get Skill](https://docs.runtm.com/cloud-api/context/skills/get.md): Retrieve a single agent directive by ID - [Update Skill](https://docs.runtm.com/cloud-api/context/skills/patch.md): Partially update a directive's metadata or content - [Delete Skill](https://docs.runtm.com/cloud-api/context/skills/delete.md): Soft-delete an agent directive - [Resync Skill](https://docs.runtm.com/cloud-api/context/skills/resync.md): Re-fetch a directive's content from its upstream source - [Presign Upload](https://docs.runtm.com/cloud-api/context/skills/presign-upload.md): Get a presigned URL for uploading a skill file directly to storage - [Discover Skills in Repo](https://docs.runtm.com/cloud-api/context/skills/discover-in-repo.md): Scan a GitHub repository for SKILL.md candidates - [Import Skill](https://docs.runtm.com/cloud-api/context/skills/import.md): Import one or more directives from a URL or GitHub repository - [List Attachments](https://docs.runtm.com/cloud-api/context/skills/attachments-list.md): List the repository attachments for a directive - [Replace Attachments](https://docs.runtm.com/cloud-api/context/skills/attachments-replace.md): Replace all repository attachments for a directive - [Lock Directive](https://docs.runtm.com/cloud-api/context/skills/lock.md): Lock a skill or MCP server against edits - [Unlock Directive](https://docs.runtm.com/cloud-api/context/skills/unlock.md): Unlock a locked skill or MCP server - [Directive Facets](https://docs.runtm.com/cloud-api/context/skills/facets.md): Aggregate label keys and values across directives - [Knowledge Catalog](https://docs.runtm.com/cloud-api/context/knowledge/catalog.md): List every available knowledge provider and its capabilities. - [List Knowledge Integrations](https://docs.runtm.com/cloud-api/context/knowledge/list.md): List knowledge integrations for the current organization. - [Create Knowledge Integration](https://docs.runtm.com/cloud-api/context/knowledge/create.md): Connect a new knowledge provider with static credentials. - [Get Knowledge Integration](https://docs.runtm.com/cloud-api/context/knowledge/get.md): Retrieve a single knowledge integration by ID. - [Update Knowledge Integration](https://docs.runtm.com/cloud-api/context/knowledge/patch.md): Update display name, metadata, or tool permissions on an integration. - [Rotate Credentials](https://docs.runtm.com/cloud-api/context/knowledge/rotate.md): Replace the credentials on a knowledge integration. - [Test Knowledge Integration](https://docs.runtm.com/cloud-api/context/knowledge/test.md): Run a connectivity check against a knowledge integration. - [Delete Knowledge Integration](https://docs.runtm.com/cloud-api/context/knowledge/delete.md): Permanently delete a knowledge integration and its stored credentials. - [OAuth Install](https://docs.runtm.com/cloud-api/context/knowledge/oauth-install.md): Start an OAuth connection flow for a knowledge provider. - [Get Allowlist Policy](https://docs.runtm.com/cloud-api/guardrails/allowlist-policy-get.md): Retrieve the default allowlist policy for an organization. - [Set Allowlist Policy](https://docs.runtm.com/cloud-api/guardrails/allowlist-policy-set.md): Set the default allowlist policy for an organization. - [Get Org Limits](https://docs.runtm.com/cloud-api/guardrails/org-limits-get.md): Retrieve the usage limits and deployment policy for an organization. - [Set Org Limits](https://docs.runtm.com/cloud-api/guardrails/org-limits-set.md): Set the usage limits and deployment policy for an organization. - [Org Cleanup](https://docs.runtm.com/cloud-api/guardrails/org-cleanup.md): Post-deletion cleanup of organization resources - [Deploy Permission](https://docs.runtm.com/cloud-api/guardrails/deploy-permission.md): Check whether the current user is allowed to deploy within an organization - [Deploy Limits](https://docs.runtm.com/cloud-api/guardrails/deploy-limits.md): Get plan-based deployment limits for the current user - [Resolved Key](https://docs.runtm.com/cloud-api/provider-keys/resolved.md): Get the resolved provider key after applying the org → user fallback chain - [Current Plan](https://docs.runtm.com/cloud-api/provider-keys/current-plan.md): Get the current billing plan for the authenticated user - [Get User Provider Key](https://docs.runtm.com/cloud-api/provider-keys/user-get.md): Check whether the authenticated user has a provider key configured. - [Set User Provider Key](https://docs.runtm.com/cloud-api/provider-keys/user-set.md): Store or replace a provider API key for the authenticated user. - [Delete User Provider Key](https://docs.runtm.com/cloud-api/provider-keys/user-delete.md): Remove a stored provider API key for the authenticated user. - [Get Org Provider Key](https://docs.runtm.com/cloud-api/provider-keys/org-get.md): Check whether an organization has a provider key configured. - [Set Org Provider Key](https://docs.runtm.com/cloud-api/provider-keys/org-set.md): Store or replace a provider API key for an organization. - [Delete Org Provider Key](https://docs.runtm.com/cloud-api/provider-keys/org-delete.md): Remove a stored provider API key from an organization. - [Agent Scorecard](https://docs.runtm.com/cloud-api/activity/agent-scorecard.md): Per-agent performance, spend, and value over a time window - [Session Grade](https://docs.runtm.com/cloud-api/activity/session-grade.md): The latest evaluation verdict for a run - [Personal Activity](https://docs.runtm.com/cloud-api/activity/personal-activity.md): Daily activity feed for the current user (GitHub-style grid data). - [Personal Summary](https://docs.runtm.com/cloud-api/activity/personal-summary.md): Aggregated usage stats (sessions, prompts, tokens, cost) for the current user. - [Recent Prompts](https://docs.runtm.com/cloud-api/activity/recent-prompts.md): Recent prompt history across all sessions for the current user. - [Session Usage](https://docs.runtm.com/cloud-api/activity/session-usage.md): Usage breakdown for a specific session (prompts, tokens, cost). - [Team Summary](https://docs.runtm.com/cloud-api/activity/team-summary.md): Org-wide aggregated usage summary (sessions, prompts, tokens, cost). - [Team Activity](https://docs.runtm.com/cloud-api/activity/team-activity.md): Org-wide daily activity feed (GitHub-style grid data). - [Team Members](https://docs.runtm.com/cloud-api/activity/team-members.md): Per-member usage breakdown for the organization. - [Team Deploy Metrics](https://docs.runtm.com/cloud-api/activity/team-deploy-metrics.md): Deployment metrics summary for the organization. - [Team Events](https://docs.runtm.com/cloud-api/activity/team-events.md): Structured event log for the organization (audit/export). - [Team Traces](https://docs.runtm.com/cloud-api/activity/team-traces.md): Distributed traces across organization sessions. - [List Installations](https://docs.runtm.com/cloud-api/integrations/github-app/installations-list.md): List GitHub App installations accessible to the current user. - [List Repos](https://docs.runtm.com/cloud-api/integrations/github-app/repos-list.md): All repos accessible via installed GitHub Apps, fetched in parallel. - [Installation Repos](https://docs.runtm.com/cloud-api/integrations/github-app/installation-repos.md): List repos for a specific GitHub App installation. - [Installation Token](https://docs.runtm.com/cloud-api/integrations/github-app/installation-token.md): Get a short-lived access token for a GitHub App installation. - [Add Repo to Installation](https://docs.runtm.com/cloud-api/integrations/github-app/installation-add-repo.md): Add a repository to a GitHub App installation's access list. - [Delete Installation](https://docs.runtm.com/cloud-api/integrations/github-app/installation-delete.md): Remove a GitHub App installation record. - [Token for Repo](https://docs.runtm.com/cloud-api/integrations/github-app/token-for-repo.md): Get an installation access token scoped to a specific repo owner. - [Authorize](https://docs.runtm.com/cloud-api/integrations/github-user-tokens/authorize.md): Exchange an OAuth code for a GitHub user token. - [Get User Token](https://docs.runtm.com/cloud-api/integrations/github-user-tokens/user-token.md): Get a valid GitHub user access token, auto-refreshing if expired. - [Token Status](https://docs.runtm.com/cloud-api/integrations/github-user-tokens/user-token-status.md): Quick check if a GitHub user token is connected and valid. - [Validate Token](https://docs.runtm.com/cloud-api/integrations/github-user-tokens/user-token-validate.md): Validate the stored GitHub user token against the GitHub API. - [Delete Token](https://docs.runtm.com/cloud-api/integrations/github-user-tokens/user-token-delete.md): Revoke and delete the stored GitHub user token. - [OAuth Install URL](https://docs.runtm.com/cloud-api/integrations/linear/oauth-install.md): Get the OAuth URL to install the Linear integration. - [Get Integration](https://docs.runtm.com/cloud-api/integrations/linear/integration-get.md): Get the current Linear integration status and configuration. - [Update Integration](https://docs.runtm.com/cloud-api/integrations/linear/integration-update.md): Update the Linear integration configuration. - [Delete Integration](https://docs.runtm.com/cloud-api/integrations/linear/integration-delete.md): Disconnect the Linear integration for the organization. - [List Projects](https://docs.runtm.com/cloud-api/integrations/linear/projects.md): List Linear projects in the connected workspace. - [Get User Connection](https://docs.runtm.com/cloud-api/integrations/linear/user-connection-get.md): Get the current user's Linear identity link status. - [Delete User Connection](https://docs.runtm.com/cloud-api/integrations/linear/user-connection-delete.md): Remove the current user's personal Linear identity link. - [List Linear Integrations](https://docs.runtm.com/cloud-api/integrations/linear/integrations-list.md): List every Linear bot in the organization - [Create Manual Linear Bot](https://docs.runtm.com/cloud-api/integrations/linear/integrations-manual.md): Create a Linear bot headlessly from a personal API key - [Get Linear Integration by ID](https://docs.runtm.com/cloud-api/integrations/linear/integrations-item.md): Get, update, or delete one Linear bot - [List Linear Teams](https://docs.runtm.com/cloud-api/integrations/linear/teams.md): Teams in the connected Linear workspace - [Email Availability](https://docs.runtm.com/cloud-api/integrations/email/status.md): Whether email triggers are available in this environment - [List Email Integrations](https://docs.runtm.com/cloud-api/integrations/email/list.md): List the organization's email inboxes - [Provision Email Integration](https://docs.runtm.com/cloud-api/integrations/email/provision.md): Create an email inbox that launches sessions - [Update Email Integration](https://docs.runtm.com/cloud-api/integrations/email/update.md): Edit an email inbox; omitted fields are left unchanged - [Delete Email Integration](https://docs.runtm.com/cloud-api/integrations/email/delete.md): Remove an email inbox - [OAuth Install URL](https://docs.runtm.com/cloud-api/integrations/slack/oauth-install.md): Get the Slack OAuth URL to install the managed Runtime app. - [App Manifest](https://docs.runtm.com/cloud-api/integrations/slack/manifest.md): Get the Slack App Manifest URL for self-hosted setup. - [Get Integration](https://docs.runtm.com/cloud-api/integrations/slack/integration-get.md): Get the Slack integration configuration and status. - [Save Integration](https://docs.runtm.com/cloud-api/integrations/slack/integration-save.md): Save or update the Slack integration configuration. - [Test Integration](https://docs.runtm.com/cloud-api/integrations/slack/integration-test.md): Send a test message to verify the Slack integration is working. - [Delete Integration](https://docs.runtm.com/cloud-api/integrations/slack/integration-delete.md): Disconnect the Slack integration for the organization. - [WebSockets Overview](https://docs.runtm.com/cloud-api/websockets/overview.md): Real-time communication via WebSockets - [Token Exchange](https://docs.runtm.com/cloud-api/websockets/token-exchange.md): Exchange an API key for a short-lived WebSocket token - [Terminal WebSocket](https://docs.runtm.com/cloud-api/websockets/terminal.md): Interactive terminal access via WebSocket - [Prompt WebSocket](https://docs.runtm.com/cloud-api/websockets/prompt.md): Stream prompts and agent output in real-time - [Collaboration WebSocket](https://docs.runtm.com/cloud-api/websockets/collaboration.md): Real-time presence and collaboration - [Open Source](https://docs.runtm.com/open-source/overview.md): Self-host Runtime, use the CLI, and work with the OSS deployment API - [Agent Workflow](https://docs.runtm.com/open-source/guides/agent-workflow.md): How agents propose changes and humans approve them - [Discovery Metadata](https://docs.runtm.com/open-source/guides/discovery.md): Make your deployments searchable with discovery files - [Logs & Debugging](https://docs.runtm.com/open-source/guides/logs-debugging.md): Advanced log filtering and debugging techniques - [Troubleshooting](https://docs.runtm.com/open-source/guides/troubleshooting.md): Common issues and how to fix them - [Machine Tiers](https://docs.runtm.com/open-source/features/machine-tiers.md): Choose the right resources for your workload - [Secrets & Environment Variables](https://docs.runtm.com/open-source/features/secrets.md): Manage environment variables and secrets for deployments - [Database](https://docs.runtm.com/open-source/features/database.md): Persistent SQLite storage for your applications - [Authentication](https://docs.runtm.com/open-source/features/auth.md): Add user authentication to web-app template - [Custom Domains](https://docs.runtm.com/open-source/features/custom-domains.md): Connect your own domain name to deployments - [Templates](https://docs.runtm.com/open-source/templates/overview.md): Starter projects for common use cases - [backend-service](https://docs.runtm.com/open-source/templates/backend-service.md): Python FastAPI template for APIs and backends - [static-site](https://docs.runtm.com/open-source/templates/static-site.md): Next.js static site template for landing pages and docs - [web-app](https://docs.runtm.com/open-source/templates/web-app.md): Fullstack Next.js + FastAPI template for interactive apps - [Docker Template](https://docs.runtm.com/open-source/templates/docker.md): Bring your own Dockerfile for any language - [CLI Overview](https://docs.runtm.com/open-source/cli/overview.md): Install and use the Runtime command-line interface - [Sandbox Sessions](https://docs.runtm.com/open-source/cli/session.md): Run AI coding agents in isolated local environments - [Authentication](https://docs.runtm.com/open-source/cli/auth.md): Login, logout, and diagnose authentication - [init](https://docs.runtm.com/open-source/cli/init.md): Spin up a new sandbox - [run](https://docs.runtm.com/open-source/cli/run.md): Run project locally with auto-detection - [deploy](https://docs.runtm.com/open-source/cli/deploy.md): Deploy to a live URL - [validate](https://docs.runtm.com/open-source/cli/validate.md): Validate project before deployment - [fix](https://docs.runtm.com/open-source/cli/fix.md): Auto-fix common project issues - [status](https://docs.runtm.com/open-source/cli/status.md): Check deployment status - [logs](https://docs.runtm.com/open-source/cli/logs.md): View deployment logs with search and filtering - [list](https://docs.runtm.com/open-source/cli/list.md): List all deployments - [search](https://docs.runtm.com/open-source/cli/search.md): Search deployments by description and tags - [destroy](https://docs.runtm.com/open-source/cli/destroy.md): Destroy a deployment - [secrets](https://docs.runtm.com/open-source/cli/secrets.md): Manage environment secrets - [domain](https://docs.runtm.com/open-source/cli/domain.md): Manage custom domains - [config](https://docs.runtm.com/open-source/cli/config.md): Manage CLI configuration - [approve](https://docs.runtm.com/open-source/cli/approve.md): Approve agent-proposed changes - [Self-Hosting](https://docs.runtm.com/open-source/self-hosting/overview.md): Run Runtime on your own infrastructure - [Requirements](https://docs.runtm.com/open-source/self-hosting/requirements.md): Prerequisites for self-hosting Runtime - [Docker Compose Setup](https://docs.runtm.com/open-source/self-hosting/docker-compose.md): Run Runtime locally with Docker Compose - [Configuration](https://docs.runtm.com/open-source/self-hosting/configuration.md): Environment variables for self-hosted Runtime - [Admin Commands](https://docs.runtm.com/open-source/self-hosting/admin-commands.md): CLI commands for self-hosting operators - [API Overview](https://docs.runtm.com/open-source/api/overview.md): Runtime REST API for programmatic access - [List Deployments](https://docs.runtm.com/open-source/api/deployments/list.md): Retrieve a list of all deployments - [Create Deployment](https://docs.runtm.com/open-source/api/deployments/create.md): Create a new deployment or redeploy an existing one - [Get Deployment](https://docs.runtm.com/open-source/api/deployments/get.md): Get deployment status and details - [Delete Deployment](https://docs.runtm.com/open-source/api/deployments/delete.md): Destroy a deployment and release resources - [Search Deployments](https://docs.runtm.com/open-source/api/deployments/search.md): Search deployments by discovery metadata - [Get Logs](https://docs.runtm.com/open-source/api/logs.md): Retrieve build, deploy, and runtime logs - [Add Domain](https://docs.runtm.com/open-source/api/domains/add.md): Add a custom domain to a deployment - [Get Domain Status](https://docs.runtm.com/open-source/api/domains/get.md): Check the status of a custom domain - [Remove Domain](https://docs.runtm.com/open-source/api/domains/remove.md): Remove a custom domain from a deployment - [Get Current User](https://docs.runtm.com/open-source/api/user/me.md): Get information about the authenticated user - [Release notes](https://docs.runtm.com/release-notes.md): The latest from the Runtime product team. ## Optional - [GitHub](https://github.com/runtm-ai/runtm) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.