Task guide

Create your first diagram

Import a small API-to-database model, change a label, and export it.

Before you start

Prerequisites: A browser and a backup export of any current work.
Permissions and plan: No account required for local editing and export.

Steps

Export your current diagram first if you want a separate backup.
Open the editor and choose Import. Copy the example below into the source field.
Import the source. The import becomes an unpublished copy, not an update to the original server diagram.
Select the API node and change its label in the inspector.
Choose Export and save a portable JSON, YAML or Markdown file.

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 outcomeAn editable two-component diagram with one labeled flow.

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.