Skip to Main Content
Docs

Building production-grade AI workflows Complete Guide

From registering an account and running your first workflow through YAML syntax, scheduling and Webhooks, breakpoint debugging, and auto-resume — and the 528 templates and 492 modules are all covered here too.

Getting Started

Get to know Braidrun Workflow, register an account, and run through the first workflow in 10 minutes.

  • Welcome
  • Try it without signing in
  • Quick Start
  • Core Concepts
  • Hands-On: Your First Workflow
Enter This Chapter

AI Assistant

An assistant that reads the page you are on: build a flow, investigate a failure, run a job, change a setting — just say it.

  • AI assistant overview
  • Switch Identity & Model
  • Build workflows with it
  • Diagnose failed runs
  • Sessions, memory, and background runs
Enter This Chapter

Connections & Credentials

Bring external systems into your workflows: authorize once and official modules, code steps and agents can all use it — the secret never lands in the YAML.

  • Connector overview
  • Third-Party Authorizations
  • Credentials
  • BYOK: Bring Your Own Key
  • MCP Integration
Enter This Chapter

Templates & Modules

528 templates and 492 modules — clone a template to start, then compose your own flow from modules. Far faster than a blank canvas.

  • Template Library Overview
  • Instantiate from Template
  • Category Details
  • Built-In Module
  • Modularization and Reuse
  • Marketplace
Enter This Chapter

Build Workflow

A visual canvas kept in two-way sync with YAML, covering agents, code, control flow, skills and AI-assistant authoring.

  • Visual Editor
  • Step Type
  • YAML Syntax
  • Agent Configuration
  • Change an agent's model
  • Variables and Expressions
  • Skill System
Enter This Chapter

Run

Manual, scheduled, Webhook, and chained triggers, plus approvals, debugging, auto-resume, monitoring, and dashboards.

  • Manual Run
  • Scheduled Runs
  • Webhook Trigger
  • Manual Approval
  • Execution Monitoring
  • Breakpoint Debugging
  • Auto-Resume
  • artifact sharing
  • Data Dashboard
  • External Messages
Enter This Chapter

Collaboration

Teams, members, permissions - multiple people use Braidrun together.

  • Teams
  • Enterprise Workspace
  • Permissions & Sharing
Enter This Chapter

Account

Sign-up, sign-in, account settings, subscription and billing.

  • Registration and Login
  • Account Settings
  • Subscriptions and Pricing
Enter This Chapter

API Open Platform

Connect workflows to your applications and business systems through the REST API and 13 official SDK clients.

  • Overview
  • Official SDK
  • API Key Management
  • Authentication and Rate Limiting
  • Webhook Endpoint
  • v1 Endpoint Reference
Enter This Chapter

Reference

Best practices, glossary, FAQ, troubleshooting, shortcuts.

  • Best Practices
  • Glossary
  • FAQ
  • Troubleshooting
  • Keyboard Shortcuts
Enter This Chapter