Step Reference
Quick Answer
Use this reference for a compact cross-step view of Breyta step families and links to each detailed step schema.
Step Families At A Glance
| Step type | Core fields | Notes |
|---|---|---|
:http | :connection or :url, :path, :method, :query, :headers, :json, :body, :response-as, :client-opts, :persist, :retry | Large and binary bodies should use :persist. |
:llm | :connection, :model, :messages or :prompt, :template, :data | Use templates for long prompts. |
:db | :database, :connection, backend-specific fields | SQL/BigQuery use :sql/:template + params; Firestore uses :collection/:where. |
:wait | :key, :notify, :timeout | Supports human/webhook resume patterns. |
:function | :code or :ref, :input | Keep reusable transforms in top-level :functions. |
:notify | :channels (:http), optional :template, :data | External delivery channels only. |
:kv | :operation, :key, operation-specific fields (:value, :ttl, :prefix) | Useful for state handoff/cache patterns. |
:sleep | one of :seconds, :millis, or :duration | Deterministic delay boundary. |
:ssh | :connection, :command, :env, :workdir, :timeout | Remote exec over SSH; for agents use :ssh kickoff + :wait callback. |
:search | :query, optional :targets, optional :limit, optional :hydrate | Workspace search across :resources, :flows, :runs, and :connections, with default resource content hydration for :resources hits. |
Common Step Options
| Option | Meaning | Typical use |
|---|---|---|
:title | Readable step label | Improves timeline readability. |
:timeout | Step timeout seconds | Bound slow external operations. |
:retry | Retry policy | Handle transient external failures. |
:on-error | Error policy (:fail, :skip, :checkpoint) | Control failure handling behavior. |
:persist | Store outputs as refs | Keep large outputs out of inline payloads. |
:review / :confirm | Human checkpoints | Add explicit approval/verification points. |
Detailed References
| Doc | Scope |
|---|---|
REFERENCE_STEP_HTTP.md | HTTP request/response and persistence behavior |
REFERENCE_STEP_LLM.md | LLM message/prompt and tool usage |
REFERENCE_STEP_DB.md | Shared DB step concepts and backend split |
REFERENCE_STEP_DB_SQL.md | SQL backends (:postgres, :mysql, :clickhouse) |
REFERENCE_STEP_DB_BIGQUERY.md | BigQuery-specific DB behavior |
REFERENCE_STEP_DB_FIRESTORE.md | Firestore-specific DB behavior |
REFERENCE_STEP_WAIT.md | Wait/signal/timeout and approval flows |
REFERENCE_STEP_FUNCTION.md | :function step and deterministic transforms |
REFERENCE_STEP_NOTIFY.md | Notification channel delivery |
REFERENCE_STEP_KV.md | KV read/write/list operations |
REFERENCE_STEP_SLEEP.md | Sleep timing semantics |
REFERENCE_STEP_SSH.md | Remote exec and agent kickoff patterns |
REFERENCE_STEP_SEARCH.md | Workspace search step behavior and limits |
GUIDE_PERSISTED_RESULTS_AND_RESOURCES.md | Working with persisted refs/resources |