Quick Start

This article takes you from "just opening the website" to "running through a real workflow" without writing code or installing anything in the middle. Follow along and you will recognize almost all the most commonly used concepts in Braidrun Workflow.

Panorama Preview: What to Expect in This One

Below is the path we will take in order. Each step will explain "why you do this", not a dry operation manual:

1. Register an account → Log in
2. Go to the "Workflow" page to get to know the main console
3. Clone a ready-made workflow from the template library
4. Check its structure with dry-run
5. Bind your LLM Key (BYOK)
6. Run it once and understand the real-time event stream
7. Hang up a cron and let it run automatically every day

Step 1 · Register An Account

1.1 Open The Registration Page

Click "Login" in the upper right corner of the homepage, click "Create Account" at the bottom of the login page, or visit directly /register.

1.2 Invitation Code or Open Registration

Braidrun is currently in the invitation-only closed beta stage, which means:

• You need an invitation code to complete registration;
• If you don't have an invitation code, please leave your email address in the "Apply for Invitation Code" form on the homepage. We will contact you first when the quota is opened.

After getting the invitation code, just fill in the email + password + invitation code. You can also use Google/GitHub OAuth to log in with one click (this method does not require an invitation code but still needs to wait for administrator approval). For detailed procedures, see Registration and Login.

1.3 Email Verification And Activation

After submitting the form, you will receive a verification email. Click the link inside to activate your account. Before activation you can browse the page but cannot create/save/execute workflows - there will be an orange reminder banner at the top.

Step 2 · Enter the Workflow Console

2.1 Left Main Navigation

After logging in you land on the home page. On the left is a fixed navigation bar, which you will definitely use:

• Workflow — Your main battlefield. All workflows are listed here.
• Templates — 240+ prebuilt workflows, clone and go.
• Modules — 120+ reusable modules, plus the ones you promote yourself.
• Run History — List of all recent executions.
• Schedules — Timing/Webhook trigger entries.
• Approvals — When the workflow is in the "Manual Approval" step, the approver approves from here.
• Credentials — All API Keys are placed here and stored encrypted.

2.2 Three Quick Entrances to the Home Page

The homepage is not an empty space. It provides three starting points:

1. Create a new blank workflow — Start with a blank canvas. It is recommended to choose this after you are already familiar with the platform.
2. Clone from template — This guide follows this path. Get started quickly.
3. Let the AI assistant generate — The FAB in the lower right corner opens the side AI assistant. Use natural language to describe what you want to do, and it will give you a first draft.

Step 3 · Clone from Template Library

3.1 Choose a Template That Is Closest to Your Business

open left Templates. There are classification filters in the upper left corner (operation automation, advertising delivery, data analysis, iOS development, content creation, compliance review...); there are search boxes and tag filters in the upper right corner.

It is recommended to choose one of these two categories for the first time:

• "Daily News Digest" — The logic is simple, the steps are few, and the complete data flow can be seen.
• "ASA Weekly Report" — Real business scenario, using scheduling + sub-workflow + Slack delivery.

3.2 Reading Template Cards

Click to see:

• "Description" - what it does
• "Required Credentials" - What keys need to be filled in when running?
• "Example input/output" - representative of typical results
• "Estimated duration/cost" - Approximately how many minutes and how many dollars will a run cost?

3.3 Clone To Workspace

Click on the upper right corner "Use this template". After confirmation, the platform will /workflows An independent copy will be generated for you below - no matter how you change it later, it will not affect the original template.

Step 4 · Use Dry-Run to First Look at the Structure

4.1 why is it necessary to dry-run?

The core value of dry-run is "zero cost": it will go through the complete DAG, but replace all LLM calls and external side effects (sending messages, writing databases, deducting payments, etc.) with safe no-ops. You can see:

• Where does the variable flow to - quoted {{...}} Is there any misspelling?
• Which steps are skipped by condition
• Which credentials the template depends on - know in advance what to configure in the Credential Center

4.2 Start Dry-Run in the Editor

1. At the top of the workflow editor, click "Execution".
2. Check "dry-run (do not adjust LLM/do not generate side effects)" in the dialog box.
3. Fill in some necessary parameters according to the template prompts, and leave the rest as default.
4. Click "Start Execution". The editor will automatically switch to the execution details view.

Step 5 · Configure an LLM Key (BYOK)

5.1 What Is BYOK

"Bring Your Own Key". You can get an API Key from a provider such as OpenAI / Anthropic and add it to Braidrun so that it can be called on your behalf. Benefits:

• Token consumption is directly recorded in your own LLM account, and the platform does not increase the price.
• You can use the advanced models of your own account - such as Claude Opus, GPT-5 - without the platform's unified guarantee.
• Rotating/revoking keys is entirely up to you.

5.2 GET A Key

The most common ones:

• OpenAI — platform.openai.com/api-keys
• Anthropic — console.anthropic.com
• DeepSeek — platform.deepseek.com
• Kimi — platform.moonshot.cn

5.3 Store It In Credentials

1. Open Credentials.
2. Click "New Credentials".
3. Select api_key as the type; choose a recognizable name, such as openai_main、anthropic_personal;Value pastes the key you got from the provider.
4. Save. The platform will immediately use AES-256-GCM to encrypt the database - after that, this field can only be overwritten and cannot be read back.

For a more complete explanation (third-level namespace, provider binding, rotation process), see Credentials and BYOK · Bring Your Own LLM Key.

Step 6 · Take a Real Run

6.1 Start Execution

1. Return to the workflow editor and click "Execute" at the top.
2. This time in the dialog box Cancel Check dry-run.
3. Fill in the necessary parameters again - usually the same as for dry-run the first time.
4. Click "Start Execution".

6.2 Understand the Real-Time Event Stream on the Right

On the right of the page is an event stream pushed in real time over WebSocket. Each row is an event, and you can filter by category:

• Agent utterance — an Agent's intermediate output, most common in group_chat steps;
• LLM call — a summary of each model call, with input / output token counts;
• Tool call — which tool the Agent called; expand to see the arguments and return value;
• External message — a record of messages the workflow sent to channels like Slack or Telegram.

For more on the event categories, see Execution Monitoring and Logging.

6.3 Look at the Results and Products

After the run finishes, click "View execution details" at the top:

• Each green bar in the Gantt chart is a successful step; hover the mouse to see how long it took.
• Click a step to see its input/output/log/variable snapshot.
• You can preview or download Markdown / Excel / screenshots, etc. in the product column.

Step 7 · Schedule the Workflow with cron

7.1 Create A New Schedule

1. "Scheduling Management" on the left → "New Schedule".
2. As the target workflow, select the one you just ran through.
3. Select cron as the type; fill in the expression 0 8 * * *(8:00 a.m. every day); select Asia/Shanghai as the time zone.
4. If the workflow has variables, fill in the default values for this batch of schedules in "Parameter Default" (each scheduled trigger will start with these values).
5. Save. There is one more item in the list, and the "next trigger time" is calculated and displayed in real time.

7.2 How to Ensure No Duplication in Scheduling

The platform automatically performs distributed locks under multi-instance deployment: the same schedule will only be triggered on one machine at the same minute. You don’t need to worry about repeat runs.

Timing scheduling can also be configured in interval / one-time mode. For details, see Scheduled Runs.

After Doing This, You Already Know How To

• Complete process of registration/login/email verification
• Template library clone → Editor dry-run → Basic loop of real run
• The role of Credential Center and the significance of BYOK
• The ability to read the real-time event stream and the execution details page
• Hang the workflow to the cron automatic running entrance

What To Watch Next

• Core Concepts — The relationship between workflow / step / agent / module / execution / credential is clearly explained in a picture.
• Hands-On: Your First Workflow — Write down a real business workflow step by step, with all the concepts tied together
• Visual Editor — Explain the canvas / YAML / toolbar / collaboration lock / version snapshot one by one
• Best Practices — Don’t step on the pits you’ve stepped on again