Docs · The field manualGuides and reference

Learn it by building something real.

Short guides that start from an empty workspace, plus the reference you keep open while you build. Every example uses Fernleaf Supply, our sample outdoor gear shop.

Storefront/Orders page/Table

Dev

Data

Readslist · 3 rows

order	customer	total	status
#10482	Harshal	612.50	Paid
#10481	Charudatt	148.00	Shipped
#10480	Dipak	42.00	Shipped

Fig. 1. An expression, read against Fernleaf sample data. Type your own.

01Start here5 guides

Five guides to start with.

Each one builds a small, real piece of Fernleaf Supply. Do them in any order.

Guide 01 · Web apps Build your first app An orders page with a table, a form and a button. Then publish it. 6 stepsStart the guide Guide 02 · Data Connect a database Bring the PostgreSQL, MySQL or SQL Server tables you already have into the Data console. Start the guide Guide 03 · Workflows Your first workflow When an order is placed, check stock and email the customer. Every run is logged. Start the guide Guide 04 · Test automation Record your first test Record a journey on fernleaf.app with the browser extension, then replay it. Start the guide Guide 05 · Search engine Set up the search engine Search the Products table, forgive typos, then drop a search block on a page. Start the guide

02ConceptsHow the pieces fit

How the pieces fit together.

Read these once. They explain the words every guide and reference page uses.

Also in Concepts

03GuidesBy builder

What people look up most.

Each guide does one task in one builder, from start to finish.

Every guide, by builder

Same order as the sidebar

Web apps

Dashboards

Workflows

Test automation

Search engine

Data

Veylo AI

Teams & security

Our cloud or your servers

API and CI

04ReferenceFig. 2

Every item gets its own page.

Reference covers every part, method, event, action, query type, block, message and route. Two pages are written out as samples: the Table component and the Parse File block.

Reference · Component

Components

Every part in the builder's Add panel, grouped as the panel groups them.

TableSample page
Form
Button
Input
Select
Chart
BI chart
Dialog
Tabs
Upload

Reference · Component method

Component methods

What the Control component step can do to a part you named.

Show
Hide
Toggle Visibility
Enable
Disable
Set Prop
Focus
Scroll Into View

The Table has no methods of its own. A Run query step refreshes its rows.

Reference · Event

Events

What a part can fire, as the events picker lists them.

Click
Double Click
Key Down
Mount
Visible
Before Page Load
On Page Load
On Page Unload

Parts add their own events too, such as the Table's Row clicked. A composite can send its own with a Raise event step.

Reference · Action

Actions

The steps that can run when an event fires, grouped as the step picker groups them.

Run query
Run workflow
Navigate
Set variable
Show alert
If / else
Wait
Authentication
Control component
Approvals

Reference · Query type

Query types

Where a query reads its data from, as the New query menu shows it.

Connection query
REST API
Storage
Messaging
App action
JS query
Static JSON
Search

Reference · Workflow block

Workflow blocks

Every block you can add to a workflow, grouped as the Add block picker groups them.

Parse FileSample page
Query
HTTP Request
Branch
Loop
Human Approval
Transform
Send email
AI
Response

The Apps group adds a Query shortcut for each app.

Reference · Test block

Test blocks

Every step you can add in the test case builder, grouped as its picker tabs.

Go to URL
Click
Type text
Wait for element
Expect text
Expect visible
Take screenshot
Visual regression
Accessibility audit
AI check

Reference · Animation

Animations

Presets in the element Animations tab, plus the options each animation has.

Fade In
Slide Up
Zoom In
Bounce In
Fade In View
Lift
Button Feel
Parallax in Section

Reference · Expression root

Expressions

Any property can hold an expression. Start with {{, pick a root, then the name you gave the part, query or block. Where you write it decides which roots you get.

In pages

Root	What it holds	Example
`components`	Values from things on this page, by name.	`{{ components.orderForm }}`
`queries`	Results of your queries: data, isLoading, error, success.	`{{ queries.getOrders.data }}`
`workflows`	Results of workflows your page runs.
`vars`	Values you set while the app runs.	`{{ vars.region }}`
`state`	Values one copy of a composite keeps to itself.	`{{ state.count }}`
`props`	Inside a composite only: values the page passed into this copy.
`loop`	The current item and its position when repeating (item, index).	`{{ loop.item }}`
`event`	What triggered this action.	`{{ event.key }}`
`params`	Values from the path, like the id in /order/42.	`{{ params.id }}`
`searchParams`	Values after the ? in the address.	`{{ searchParams.q }}`
`route`	The address being shown: its path, its parts and the page.
`page`	This page's title and path.
`user`	Who is signed in (isAuthenticated, id, email, name, firstName, lastName, avatarUrl, initials).	`{{ user.email }}`
`access`	What the signed-in person may do: roles, groups, tables, actions.
`auth`	Why the last sign-in failed, when it sent the visitor back to the page.
`env`	Your environment settings for the stage.	`{{ env.API_URL }}`
`storage`	Values kept in this browser.
`files`	Your stored files, like files.get("brand", "logo.png").	`{{ files.get("imports", "orders.csv") }}`
`lib`	Date, text and id helpers.

In queries

Root	What it holds	Example
`args`	Values passed in when the query is called (the Test arguments box).
`secrets`	Your saved keys, filled in on the server. Not offered on a page.	`{{ secrets.API_KEY }}`

In workflows and tests

Root	What it holds	Example
`blocks`	Output of earlier blocks, by name: blocks.name.data.	`{{ blocks.checkStock.data }}`
`req`	The incoming request: body, headers, query, params, method.	`{{ req.body.total }}`
`trigger`	What started the run: trigger.kind and trigger.payload.	`{{ trigger.kind }}`
`user`	The person who started the run.
`caller`	What started this run: a person, an API client or a link.
`vars`	Variables set during the run.
`env`	Your environment settings for the stage.	`{{ env.API_URL }}`
`secrets`	Your saved keys, filled in on the server and hidden in run logs.	`{{ secrets.API_KEY }}`
`files`	Your stored files, like files.get("brand", "logo.png").
`loop`	The current item inside a Loop block.
`lib`	Date, text and id helpers.
`row`	Data-driven tests: the current row. Also rowIndex and rowCount.	`{{ row.email }}`

A table reads a query

{{ queries.getOrders.data }}

Reference · Error

Errors

Word for word

Messages people see, exactly as the product shows them, with what each one means and how to fix it.

The message	What it means and how to fix it	Where you see it
"invoice.pdf" is 12 MB. This query takes files up to 5 MB.	The file is over Max upload size. Raise the limit or send a smaller file.	Uploads and files
An uploaded file was not found or has expired. Upload it again.	The waiting upload is gone. Upload the file again.	Uploads and files
"name" is not a type this upload takes.	The file type is not allowed by the upload. Pick an allowed type.	Uploads and files
Upload takes at most 20 files at a time, but "source" holds 25.	Too many files in one Upload a file action. Send 20 or fewer.	Uploads and files
"file" is a file that is not saved yet: it is still an upload waiting to be stored. Save it first with the "Upload a file" action, then use the file that comes back.	The action needs a saved file. Run Upload a file first.	Uploads and files
File "report.pdf" could not be found	No file with that name in that folder. Check the folder and name.	Uploads and files
Couldn't reach the server. Check your connection.	The upload did not reach us. Check your network and try again.	Uploads and files
Out of tokens. Buy tokens to run this. You can still view and export your data.	The balance is empty. The Owner buys tokens in Billing.	Billing and tokens
Today's spend cap is reached. Raise the cap in Billing to keep running.	The daily cap stopped new runs. Raise it, or wait until midnight.	Billing and tokens
A monthly budget is used up for this kind of run. Raise it in Billing, Budgets and alerts.	A budget for this kind of run is spent. Raise it in Budgets and alerts.	Billing and tokens
New uploads are paused. Buy tokens or raise your uploads limit.	A cap stopped new uploads. Buy tokens or raise the limit.	Billing and tokens
Billing isn't set up for this workspace. Open Billing to see why.	Billing needs a fix before runs can start. The Owner opens Billing.	Billing and tokens
Couldn't publish. A public app needs a card on file. Add a card or buy tokens, then publish.	Public apps need a card or tokens before they go live.	Billing and tokens
Couldn't start the order. Tick "Tokens don't expire and can't be refunded." first.	Tick the box in checkout, then start the order again.	Billing and tokens
Couldn't run query	The toast title. The line under it gives the reason from the server.	Queries
The server didn't say why.	The query failed with no reason. Check the connection and the query settings.	Queries
Couldn't start the run.	Money or the plan said no. The line under it says which, and what to do.	Workflows
Run stopped	Someone pressed Stop on the run.	Workflows
Stopped: this run reached its limit of 100 queries, or the balance reached the run floor.	The run hit its query limit or ran low on tokens. Buy tokens or lower the work.	Workflows
HttpRequest timed out after 30000ms	The other server did not answer in time. Retry, or raise the timeout.	Workflows
Incorrect email	No account has that email. Check the spelling.	Sign-in
Incorrect password	The account exists but the password is wrong. Try again or reset it.	Sign-in
Couldn't sign in. Try again in a moment.	The sign-in request failed. Wait a moment and try again.	Sign-in

Reference · API and CI

API and CI

What you can use to start work from outside the builder.

Test run keys
POST /api/v1/ci/test-cases/{idOrKey}/run
POST /api/v1/ci/test-suites/{idOrKey}/run
Webhook
Schedule
Form
Chat
Error handler

Every reference page answers the same questions

Pages of one kind share one layout, in this order, so you always know where to look.

Kind	What its page covers
ComponentSample: Table	What it does When to use it Settings Data Methods Events it fires Styles Animations Example Limits Related
Component method	What it does Arguments What it returns Example Errors Related
Event	When it fires What {{ event }} holds Parts that fire it Example Related
Action	What it does Settings What it returns Example Errors Related
Query type	What it reads or writes Settings What it returns Example Errors Limits Cost Related
Workflow blockSample: Parse File	What it does When to use it Settings Inputs Outputs Example Errors and fixes Limits Cost Related
Test block	What it does Settings What it checks Example Errors Related
Animation	What it looks like Options When it plays Example Related
Expression root	What it holds Fields Where you can use it Example
Error	The message What it means How to fix it Where you see it

Fig. 2. One layout per kind. Each page head also shows the release that added the item.

05ReleasesChangelog

One copy of the docs per release.

The docs follow the product. Pick a release in the sidebar to read the docs for it.

Release v1.0First releaseWhere the changelog starts. Each later release lists New, Improved, Fixed and Breaking.LatestRead the changelog Your own serversUpgrade guidesEach release comes with the steps to move to it, and anything that breaks says what to change.Upgrade guides Docs v1.0VersionsCloud workspaces always run the latest release. On your own servers, pick the release you run.All versions

Still stuck?

Need a hand?Ask the teamTell us what you are building and where it got stuck.Contact us Opening soonGet early accessWe open in waves. Join early access and we'll email you when your workspace is ready.Get early access

Learn it by building something real.

Five guides to start with.

How the pieces fit together.

What people look up most.

Every guide, by builder

Every item gets its own page.

Components

Layout

Forms and inputs

Date and time

Capture and devices

Buttons and actions

Navigation

Overlays

Feedback and status

Data display

Media and embeds

Text and code

Charts and tables

Search

Component methods

Show and hide (any part)

Enable and disable

Properties

Focus and input

Scroll

Control query (the Run query step)

Events

DOM Events (any part)

Lifecycle (any part)

Page events (when the page itself is selected)

Actions

Accounts

Components

Pages

Values

Messages

Logic

Workflow

Search

Query types

Types

Storage actions: files

Storage actions: folders

Messaging channels

Workflow blocks

Control flow

Data and logic

Action

AI

Test blocks

Browser

Assertions

State

Logic

Network

AI

Animations

Load

In View

Exit (plays when the part hides)

Hover

Tap

Hover+Tap

Scroll

States (tabs on an animation)

Properties you can animate

Timing options

Scroll tracks

Expressions

In pages

In queries

In workflows and tests

Errors

API and CI

Test run keys (CI)

Workflow triggers

Run log

Every reference page answers the same questions

One copy of the docs per release.