Task guide

Explain a runtime flow

Connect two services and inspect direction, speed and labels.

Before you start

Prerequisites: Two nodes in an editable diagram; the example below supplies both.
Permissions and plan: Local editing is free; published updates require write access.

Steps

Open the API and database example in the desktop editor.
Select the API-to-database connection to inspect its label, direction and appearance.
Choose Connect, click a source object and then a different destination to add a relationship.
Use the flow controls to author a named flow when you want to present a sequence; Present plays it without authoring tools.
Choose Export & view → Edit source & export and inspect the flows array or Flows section.

Runnable example

Flowboard Markdown

Copy this model into Import in the editor. Export current work first. The two stable identifiers, api and db, connect the services to the flow.

# Request path

- API {#api type=service x=100 y=120}
- Database {#db type=database x=500 y=120}

## Flows
- api -> db {#requests label="requests" color=#f05a47 speed=1 direction=forward}

Change a label to describe your system. Keep the identifiers the same when you want existing connections to keep referring to those nodes.

Check your work

Expected outcomeOne labeled relationship whose direction you can explain.

Next steps

Try the workflow in the editor, then use the reference for control details and model syntax.

Open the example or setup page Detailed reference

If a step does not work, keep an export of your model and follow the troubleshooting guide. Include the error message when contacting support, without sharing credentials or private architecture.