For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
  • Getting Started
    • What is Runtype?
    • Creating your account
    • Platform keys vs. BYOK
    • Understanding the Runtype UI
    • Quickstart: Social Media Post Generator
    • Quickstart: From Agent to Chat Widget
  • Dashboard
    • What is the Dashboard?
    • Daily executions
  • Playground
    • What is the Playground?
  • Products & Surfaces
    • What are Products?
    • What are Surfaces?
    • Creating a product
    • Setting up a chat surface
    • Setting up an API surface
    • Setting up an MCP surface
    • Setting up an A2A surface
    • Setting up a Slack surface
    • Setting up a webhook surface
    • MCP authentication
    • Authenticating with product API keys
    • Embedding the chat widget (script tag)
    • Embedding the chat widget (React)
    • Surface orchestration modes
    • Product views
    • Adding capabilities to a product
    • Connecting external agents
    • How A2A works
    • Connecting to MCP clients
    • Scoping API keys to capabilities
    • Auto-generated OpenAPI spec
    • Calling your API endpoints
    • Client tokens and domain restrictions
    • AI-powered theme generation
    • Widget theming and customization
    • Product versioning and status
  • Flows
    • What are Flows?
    • Creating and editing flows
    • Flow step types overview
    • Agent and flow templates
    • Using prompt steps
    • Using transform-data steps
    • Using conditional steps
    • Using fetch-url and api-call steps
    • Using record steps (upsert/retrieve)
    • Flow variables and templates
    • Flow versioning and publishing
    • Running flows in batch
    • Handling batch failures
    • Debugging flows
  • Agents
    • What are Agents?
    • Creating and configuring agents
    • Agent tools
  • Records
    • What are Records?
    • Creating and managing records
    • Using records in flows
    • Filtering and searching records
  • Tools
    • What are Tools?
    • Built-in tools
    • Creating custom tools
    • Creating external tools
    • Runtime tools
  • Evals
    • What are Evals?
    • Running an eval
    • Interpreting eval results
  • Schedules
    • What are Schedules?
    • Automating batch processing
  • Logs
    • What are Logs?
    • Working with logs
  • Integrations
    • Connecting AI model providers
    • Slack integration
    • Google Workspace integration
    • GitHub integration
    • Linear integration
    • Weaviate (vector search)
    • Firecrawl (web scraping)
    • Exa (web search)
    • Braintrust (tracing)
  • Settings
    • What's in Settings?
    • Available AI models
    • What are Organizations?
    • Managing AI models
    • Managing API keys
    • Managing secrets
    • Billing and plans
    • Usage data
    • Team members and permissions
    • Appearance and preferences
    • Integrations (PostHog, Weaviate, Daytona)
  • Troubleshooting & FAQ
    • FAQ
    • Rate limits and usage
    • Managing Runtype with Claude
    • Agent skills
    • Flow execution failures
    • Common errors and solutions
    • Authentication issues
Dashboard
LogoLogo
On this page
  • Sidebar navigation
  • List views
  • Detail pages
  • Keyboard shortcuts
  • Next steps
Getting Started

Understanding the Runtype UI

Was this page helpful?
Previous

Quickstart: Build a Social Media Post Generator as a REST API

Next
Built with

The Runtype UI is your main workspace for building, testing, and deploying AI Products. This guide walks you through the main areas so you can find what you need quickly.

Sidebar navigation

The left sidebar organizes the platform into four groups, separated by dividers.

Overview

  • Dashboard — Your home view with recent activity and quick stats
  • Playground — Experiment with prompts and models in real time

Build

  • Products — Group Flows and Agents together and deploy them through Surfaces
    • Agents — Build agentic workflows with tool use and reasoning
    • Flows — Create multi-step AI workflows with prompts, logic, and data
    • Evals — Compare models and measure how your workflows perform

Substrate

  • Models — Configure and manage AI models
  • Integrations — Connect external services and APIs
  • Tools — Create custom Tools that your Agents can call

Operate

  • Records — Manage structured data that your Flows and Agents can store, retrieve, and use as context
  • Schedules — Automate Flow execution on a recurring basis
  • Logs — Review Flow, Agent, and step execution history

At the bottom of the sidebar you’ll also find:

  • Settings — Configure API keys, billing, usage, secrets, connected apps, and team members
  • Help — Access documentation, changelog, and send feedback
  • User menu — Switch organizations, toggle between Light/Dark/System themes, manage your account, or log out

List views

Most pages share a consistent layout:

  • Search and filters — Find items quickly by name or status
  • Status badges — See whether an item is active, draft, or archived
  • Quick actions — Use the more menu (⋯) to edit, duplicate, or delete

Detail pages

When you open a Flow, Product, Agent, or other item, you’ll typically see:

  • Configuration panel — Edit settings, steps, and properties
  • Related items — View connected Capabilities, Surfaces, or dependencies
  • Action buttons — Run, test, or deploy
  • Activity and logs — Review recent executions and debug details

Keyboard shortcuts

These shortcuts help you move faster around the platform.

Global

  • Cmd/Ctrl + B — Toggle the sidebar

Tool editor

  • Cmd/Ctrl + S — Save the current Tool
  • Cmd/Ctrl + Enter — Open the test panel

Log viewer

  • j / k — Navigate between entries
  • g / G — Jump to top or bottom
  • Enter — Expand or collapse an entry
  • / — Focus the search input
  • r — Refresh logs
  • l — Toggle live tail mode
  • c — Copy the selected entry
  • ? — Show all keyboard shortcuts

Next steps

  • Creating and editing Flows
  • What are Products?
  • Using the Playground