flowboard
Skip to documentation

Task guide

Create your first diagram

Open a small working model, edit it visually, and keep a portable backup.

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

  1. Open the example below on a desktop browser. It uses a separate browser draft; your main draft stays at /app.

  2. Select the API object and change Name in the inspector. Click outside the field to finish.

  3. Choose Add to create a shape, or Browse cloud & technology icons to choose a recognizable icon.

  4. Choose Connect, click a source object, then a different destination. Select the connection to name it.

  5. Choose Save → Download JSON backup. For Markdown or YAML, choose Export & view → Edit source & export, select Format, then Download source.

  6. To use the source below instead, choose Export & view → Import model, select Markdown, paste it, and choose Import as new draft.

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 request-path diagram and a portable backup.

Next steps

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

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.