Reference Index
Quick Answer
Use this page as the docs map when you know the topic but not the exact page.
For the default authoring path, start with Author Flows.
For the full command catalog, use CLI Commands.
Topic Lookup
| Topic | Values / Scope | Reference |
|---|---|---|
| CLI lifecycle | Draft authoring, configure/check, run, release, promote, installations | CLI Workflow |
| Authoring playbook | Template reuse, existing data, interfaces, lint/push, single-step development, resource refs | Author Flows |
| Debug playbook | Failed runs, UI mismatch, output proof, feedback reports | Debug And Verify |
| Release/install playbook | Draft/live, release/promote, live target configuration, install-shaped proof | Release And Install |
| Public/marketplace playbook | Discover, marketplace, public copy, paid/public surfaces, author approval | Public And Marketplace |
| Reliability playbook | Fanout, paging loops, concurrency, checkpoints, large artifacts | Advanced Reliability |
| Command catalog | Canonical CLI surface and docs navigation | CLI Commands |
| Docs search | breyta docs find, query syntax, field filters, snippets, and explain mode | Docs Search |
| Flow metadata | Grouping, display icon selection, publish description, public discover visibility, and app-owned paid plan catalogs | Flow Metadata And Discover |
| Paid public flows | Stripe Connect seller onboarding, marketplace visibility, app monetization, plan catalogs, and public discover publishing | Paid Public Flows |
| Flow health | Incidents, digests, and cadence behavior | Flow Health |
| Service accounts | Workspace machine principals, API keys, and worker auth | Service Accounts |
| Public flow naming | Titles, slugs, descriptions, tags, step titles for reusable/public flows | Flow Naming |
| n8n import | n8n workflow to Breyta flow migration | n8n Import |
| Slot types | :http-api, :database, :blob-storage, :kv-store, :secret | Flow Configuration |
| Auth types | Outgoing HTTP: :api-key, :bearer, :token, :basic, :aws-sigv4; webhook interfaces: :hmac-sha256, :signature, :ip-allowlist, :none (:none not valid for webhook interfaces) | HTTP Step, Webhooks And Secret Refs |
| Interfaces and schedules | :manual, :http, :webhook, :mcp, top-level :schedules | Flow Definition |
| Manual interface inputs and uploads | :invocations {:default {:inputs [...]}}, :interfaces :manual, :file, :blob-ref, :resource, :multiple, :accept | Flow Definition — Invocation Inputs |
| Worker requirements | {:kind :worker ...} inside :requires | Flow Definition |
| Run concurrency | :singleton, :keyed, :supersede, :drain, :coexist | Run Concurrency |
| Step types | :http, :llm, :agent, :db, :wait, :function, :job, :notify, :kv, :table, :files, :fanout, :sleep, :ssh, :search, :breyta | Step Reference |
| LLM image inputs | Uploaded/persisted image resources in :llm messages and :agent inputs for vision-capable models | Step LLM — Image Resource Inputs and Step Agent — Image Resource Inputs |
| AWS Bedrock LLM | Bedrock Claude connections, :backend :bedrock, AWS SigV4 auth, model ids, and uploaded/reference files in LLM messages | Flow Configuration, Step LLM — AWS Bedrock Claude, Step HTTP — AWS SigV4 |
| Agent step | Objective-driven agent with memory, plan/checkpoint, cost controls, evaluation, approval gates, tracing, and delegation. The agent-safe :files subset, :table, :search, and allowlisted :breyta control-plane tool can be exposed directly; broad side-effecting operations require packaged :steps | Step Agent |
| Packaged steps | Flow-local qualified-keyword step wrappers with schema-backed input/output, direct flow/step invocation, and agent tool publication via :tools {:steps [...]} | Packaged Steps |
| Agent definitions | Flow-local named agent configurations invocable from flow/step by qualified id and publishable as tools via :tools {:agents [...]} | Step Agent — Agent Definitions |
| Breyta control plane | Workspace-scoped :breyta agent tools for controlled flow, run, resource, and docs operations | Step Breyta |
| MCP tools | Remote MCP endpoints bound as :http-api connections with :backend :mcp, exposed through top-level :mcp adapters and selected via :tools {:mcp [...]} | Flow Definition — MCP Tool Adapters |
| Files step | :resolve-source, :init-changeset, :list, :read, :search, :write-file, :apply-edit, :delete-file, :move-file, :materialize, :capture, :diff, :publish, and :open-change-request, with :git as the first source protocol and GitHub as the built-in provider | Step Files |
| Job step | Jobs control plane submit/get/await step surface | Step Job |
| Fanout step | Bounded child-workflow spawn/collect with legacy sequential compatibility | Step Fanout |
| Table step | :query, :get-row, :aggregate, :schema, :export, :update-cell, :update-cell-format, :set-column, :recompute, :materialize-join | Step Table |
| DB backends | :postgres, :mysql, :clickhouse, :bigquery, :firestore | Step DB |
| Orchestration constructs | let, do, if, if-not, when, when-not, cond, case, for, doseq, loop, recur | Orchestration Constructs |
| Jobs control plane | flow/step :job submit/get/await orchestration | Jobs Control Plane |
| Flow helpers | flow/poll, flow/now-ms, flow/elapsed?, flow/backoff | flow/poll |
| Form field types | Setup fields and run inputs: :string, :text, :number, :boolean, :select, :date, :email, :textarea, :password, :secret, :file, :blob-ref, :resource | Flow Definition — Invocation Inputs and Installations |
| Installations | Subscribe, activation inputs, interfaces, and webhook uploads | Installations |
| Profiles | Draft/live/installation target model and run selection | Profiles |
| Runs and outputs | Run inspection, waits, outputs, sidepeek surfaces, and output-page verification | Runs And Outputs and Output Artifacts |
| Run cost estimates | Avg Estimated Run Cost, :metering, LLM token pricing, and breyta runs show cost breakdown fields | Run Cost Estimates |
| Persisted resources | res:// refs, blobs, tables, resource inspection, and how persisted resources become rendered output artifacts | Persisted Results And Resource Refs and Output Artifacts |
| Runtime data shapes | Function input maps, CLI envelopes, resource refs, :persist, :load, and avoiding parser bloat | Runtime Data Shapes |
| Table resources | CLI storage filters, table-family limits, partitioning notes, and table output rendering | Table Resources and Output Artifacts |
| Troubleshooting / limits | Runtime hints, common failures, and platform bounds | Troubleshooting and Limits And Recovery |
| Google Drive sync | Service-account flow operation pattern | Google Drive Sync |
| Output artifacts | Final output viewers, Markdown reports, breyta-resource embeds, raw output, JSON resource rendering, and installed-flow output contracts | Output Artifacts |
| Output artifact reference | Field tables for viewer envelopes, resource embeds, table query/aggregate/chart options, downloads, media, and structured output | Output Artifact Reference |
Navigation Hubs
- Start Here
- Author Flows
- Debug And Verify
- Release And Install
- Public And Marketplace
- Advanced Reliability
- CLI Workflow
- CLI Commands
- Docs Search
- Flow Metadata And Discover
- Paid Public Flows
- Flow Health
- Service Accounts
- Table Resources
- Step Reference
- Persisted Results And Resource Refs
- Runtime Data Shapes
- Run Cost Estimates
- Output Artifacts
- Output Artifact Reference
- Troubleshooting