FAQ

High-frequency questions are grouped by topic. If you can't find it, search for keywords first, and if that doesn't work, go to the "Troubleshooting" page to see common symptoms.

Accounts And Registration

How do I create an account?

Go to /register, enter your email, a password and the image captcha, or sign in with any of the third-party providers listed on the login page. Verify your email and you are ready to go.

Can I register with a domestic email address?

Yes. QQ / 163 / Alibaba / Tencent corporate mailboxes have been tested. Occasionally, activation emails will go into the spam folder, so check them carefully.

Can I register multiple accounts with one email address?

No. One email = one account. If you need two sets of "development/production" accounts, use + alias (your +dev@gmail.com).

Can I log in using Google / GitHub / Feishu / DingTalk?

Yes. Braidrun supports 14 third-party logins: Google · GitHub · GitLab · Microsoft · Apple · Slack · LinkedIn · WeChat · Alipay · Feishu · Lark · DingTalk · Gitee, plus any enterprise SSO that follows the OpenID Connect standard (for example Keycloak / Authentik / Okta / Auth0). The login page only shows the options enabled in your current environment.

Subscription And Billing

Free What’s the biggest difference from Pro?

Free has only the three basic step types (single / code / classifier), no schedules, no webhooks and no breakpoint debugger, so workflows can only be started by hand. The AI assistant is unlimited on both tiers. For anything that really runs in production, go Pro or above.

Can I pay yearly?

The switch between monthly and yearly sits at the top of the pricing page, and the yearly discount is whatever that page shows; which cycles are offered depends on the deployment's configuration. To change the cycle on an existing subscription, go through checkout once — there is no separate toggle in account settings.

Can the invoice be issued to the company?

Account settings → Billing lists every payment so you can reconcile transactions. For a tax invoice, contact the support team (admin@braidrun.com). Enterprise can pay by bank transfer under a contract.

What happens if quota is exceeded?

Existing workflows and runs keep going; creating a new one is refused with an upgrade prompt (HTTP 403 resource_limit_reached). When concurrency is full, a new run waits in PENDING until earlier ones finish. The platform sends no usage warnings in advance, so archive or clean up what you no longer need as you approach a limit.

BYOK/LLM Cost

Do I have to bring my own model key?

Yes. There is no shared platform quota: configure your own provider key (personal or team) in the credential center before running an agent step; at run time it resolves personal first, then team.

How much does Braidrun charge?

There is no price increase under BYOK. What you actually pay on the Provider side is your true cost. Braidrun's revenue comes from subscription fees and does not take a commission from tokens.

Can I see how much a workflow run costs?

Can. The top of the execution details page displays tokens + cost (converted according to the Provider’s public price). Data dashboards are aggregated by day/week/month.

What If the Provider Suddenly Raises Prices?

Costs are estimated from a built-in static price table, so a provider's price change only lands after a platform release. The real bill is always what the provider charges; the numbers here are indicative.

Data Privacy

Will my data be used to train the model?

No. Braidrun itself does not train any models. When BYOK, the data destination is determined by the Provider you choose - the default policy of OpenAI / Anthropic is "not used for training", and you can further opt-out in their console.

Can credentials be compromised?

Credentials are AES-256-GCM encrypted and stored in the Credential Center; runtime decryption only takes effect in a single step context; no logs are written, no YAML export is performed, and no other steps are visible. What you get in the DB dump is the ciphertext.

Third-party authorizations use the same storage plus two extra guards: a service may only reach the hosts it declares, and an authorization that fails verification is deleted rather than left in the vault. Third-Party Authorizations

Is My Workflow YAML Private?

Yes. A personal workflow is visible only to you; a team workflow only to that team's members. Braidrun staff have no backdoor into production user workflows, and in an Enterprise self-hosted deployment even that layer runs inside the customer's own network.

Where does the data exist?

With an Enterprise self-hosted deployment the data stays entirely on your side and never reaches our servers. The SaaS edition is hosted by Braidrun: cross-border transfers rely on adequacy decisions, Standard Contractual Clauses (SCCs) or the UK International Data Transfer Addendum — see the "Data transfers" section of the Privacy Policy. The scope of export and deletion is covered by the Data Processing Agreement. If you have specific compliance requirements about storage regions, please confirm them with us during procurement.

Templates, Import, and Export

What does the template have to do with my own workflow?

Clone a copy into your workspace. Your edits aren't pushed back to the template, and template updates don't automatically change your copy. But the clone records "which version of which template it came from": after the template ships a new version, you can preview the variable differences first, then upgrade in one click — a version snapshot is saved automatically before the upgrade, and the model settings you chose are preserved. For the steps, see Instantiate from Templatethe "Template upgrade" section.

Can it be imported from Dify / Langflow / n8n?

The import endpoint only accepts Braidrun's own YAML. The template library already ships a set of templates ported from Dify scenarios that you can clone directly; for native exports from Dify, n8n or Langflow, let the AI assistant read the file and translate it into Braidrun YAML.

Can I export my workflow to another format?

YAML export is the most authoritative - this is Braidrun's native format, and it can also be run directly in the CLI (braidrun-agent). There is no one-way transfer function.

Execution And Scheduling

If an Execution Fails, Will I Be Refunded?

Braidrun does not charge per run, so refunds do not apply. The LLM token usage from a failed run is billed to your Provider account (BYOK) — if you believe a platform issue caused the failure, open a support ticket and we will help you request credit from the Provider.

cron How to troubleshoot if the trigger is not triggered?

First look at the "next trigger time" on the scheduling details page - right? Look at the "latest trigger history" again - whether it has been throttled. For detailed steps, see Troubleshooting.

Will cron be triggered twice when deploying multiple instances?

Won't. Distributed locks are used inside the platform to ensure that the same schedule will only be triggered on one machine in the same minute. There is also a dedicated lock during Auto-resume to prevent two nodes from resurrecting the same execution at the same time.

What happens to my workflow after service restart/OOM?

The execution will first retain the results and enter INTERRUPTED; if the current deployment enables automatic recovery, the workflow policy allows it, and the recovery point meets the idempotent requirements, the platform will automatically continue from the step boundary. Otherwise, you need to manually re-execute the specified steps after confirming safety.

Pure data pipeline can explicitly configure the recovery strategy, and add idempotent: true to steps that may be replayed; do not mistakenly label idempotent steps such as sending messages, changing advertising prices, and placing orders. For details, see "Service Restart Automatically Resumes".

Collaboration And Migration

How to upgrade a personal account to a team?

First upgrade to the Team package → Create Team → "Move your existing workflow to Team". Historical execution records are migrated together.

Can the team see who changed what?

Workflow version history shows the author of every save, and that is available on all plans. The full audit log (credential, schedule, approval changes and so on) is recorded server-side at all times, but the viewer is currently opened only on the Enterprise plan.

I quit my job, how do I hand over my resources?

1. Teams you own cannot currently be transferred by yourself: have the successor create a team, move the workflows over with "move to team", and dissolve the old team once nothing is left;
2. The credentials of the personal namespace allow the successor to create a new copy under the Team namespace;
3. Export personal workflow to successor;
4. Finally log out of your personal account.

Developer Issues

Is There a REST API? Can I Use It Programmatically?

have. Three authentication methods:

• API Key (recommended for CI/Automation) — Create the key in Account Settings. It uses the format `dyk_<id>_<secret>`, is authorized by scope (`WEBHOOK_TRIGGER` / `WORKFLOW_EXECUTE` / `EXECUTION_READ`, etc.), and can have an expiration time.
• Password login Bearer JWT — POST /api/auth/login for access (15 minutes) + refresh (7 days) token; only used during debugging, CI uses API Key
• Cookies (browser) — SPA uses HttpOnly Cookie + CSRF; see the account settings page for details

There is no need to manually manage tokens when there is a need to call back the platform API within the workflow (for example, creating a public link through a built-in module) - the engine automatically injects the short-term WF_API_TOKEN environment variable. See the developer manual for details.

Is CLI Supported?

Supported. braidrun-agent CLI uses the same workflow YAML core structure, which is suitable for local verification and CI; the account, package, credentials, collaboration or hosting module capabilities exclusive to the web page still depend on the target operating environment. Before putting online YAML into the CLI, you should first perform the verification that comes with the CLI.

Can it be deployed locally?

The Enterprise plan supports full private deployment. The open source version comes with the deployer/ tool, supports Vultr / AWS / Aliyun multi-cloud provider, CLI + GUI two modes, and can complete provision / scale / rolling-deploy / rollback / scale-controller installation. Pro/Team plans are currently only available on Braidrun SaaS.

How to do WebSocket authentication?

Use POST /api/auth/ws-ticket to get a 30-second TTL single ticket, with ?ticket=<value> in the handshake. This ticket process replaces the old Sec-WebSocket-Protocol: <JWT> path in 2026-05 (the old path is retained as a downgrade solution). The front-end composables/useExecutionWebSocket.ts has been encapsulated.

Why do my POST requests always report 403 csrf_token_mismatch?

Starting from 2026-05-08, the platform will enable HttpOnly Cookie + double submission CSRF verification by default. The front-end SPA must: (1) GET /api/auth/csrf get the dy_csrf cookie when loading for the first time; (2) all POST/PUT/PATCH/DELETE requests echo the cookie value to the X-CSRF-Token header; (3) axios is configured with withCredentials: true. When testing directly with curl: curl -c /tmp/jar https://host/api/auth/csrf to get the cookie first, then add -b /tmp/jar and -H X-CSRF-Token: ....

Product Feedback

I Want You to Add a Template / a Step Type / an Integration

Ask for a third-party service through the request form at the bottom of the integrations page (name the service and what you would do with it). For templates, step types and similar requests, write to admin@braidrun.com and it goes into our prioritisation.

Encountered A Bug

Email admin@braidrun.com with the execution ID, workflow ID, when it happened and the steps to reproduce — never attach API keys, passwords or full credentials. Self-hosted deployments use the support channel agreed in the contract.

Next

• Troubleshooting — Specific Symptom → Fix
• Glossary — When reading other documents and encountering new words, come back and look them up