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

Do I Need an invite code to register?

No. Registration is open — sign up with your email at /register, or use any of the third-party logins below.

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 3 basic step types (single/code/classifier) and no scheduling/webhook/breakpoint debugger/automatic continuation. Suitable for "experience". Any real production scenario requires Pro or above.

Can the package be freely switched between monthly payment and annual payment?

Yes. Switch the billing cycle in Account Settings → Billing, and the next billing cycle will take effect. If you switch from monthly payment to annual payment, you will get an immediate discount; if you switch from annual payment to monthly payment, the annual payment will be due.

Can the invoice be issued to the company?

Yes. China supports general VAT invoices/special invoices. After filling in the header and tax number on the bill page, each deduction will be automatically generated. Enterprise can transfer funds + contracts to the public.

What happens if quota is exceeded?

Existing workflows and executions will continue to run, and new ones will be rejected (a pop-up window will prompt for an upgrade). It is recommended to use 80% / 95% warning for early processing.

BYOK/LLM Cost

Does it have to be BYOK?

Free/Pro has a small amount of built-in shared pool Key quota and enough traffic. If you really want to increase the amount, BYOK is recommended - the quota is more sufficient and the cost is lower (especially when calling DeepSeek on a large scale).

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?

Provider price list changes will be captured by the platform and our cost estimates will be updated. The real bill is always settled on the Provider side.

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.

Is My Workflow YAML Private?

Yes. Personal workflow is only visible to you; team workflow is only visible to team members by role; Braidrun employees have no backdoor to view user workflows in the production environment. In Enterprise privatized deployment, even this layer is managed by the client's intranet.

Where does the data exist?

The SaaS version is available in the Hong Kong / Singapore / AWS Tokyo regions. Enterprise is deployed privately entirely on the customer side. Details can be found in the "Data Processing Agreement (DPA)" document.

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?

Dify workflow supports one-click import (will automatically convert to YAML format). Langflow and n8n do not currently support native import, but the AI assistant can read their JSON exports and "translate" them to Braidrun YAML for you.

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-view, so there is no need for refunds. The LLM token consumption that occurs when a failure occurs will be recorded in your Provider account (BYOK) - if you think the failure is caused by a platform problem, you can submit a work order and we will assist you in asking the Provider for credit.

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?

By default, all running executions are marked as INTERRUPTED, and you need to manually click "Restart from a step". This is the default behavior to prevent steps with side effects such as Telegram/ad price changes/sending emails from being accidentally triggered repeatedly.

If your workflow is a "pure data pipeline" (read-only API, pure calculation, write local artifact), you can opt-in automatic recovery: add recovery.autoResumeOnRestart: true to the workflow YAML, and add idempotent: true to each rerunable step. See /docs/run/recovery for details.

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?

able. Every change in workflow/credentials/scheduling/approval will be recorded in the team audit log, which can be viewed by team members with Owner/Admin roles. At the same time, the workflow version history can see the author of each save.

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

1. Transfer the ownership of the Team in which you are the Owner to the successor;
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?

support. braidrun-agent CLI can run YAML locally - 100% compatible with workflow YAML on the web side. Good for CI integration.

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 equipped with withCredentials: true. Use curl directly to measure the time: curl -c /tmp/jar https://host/api/auth/csrf Get the cookie first, then bring -b /tmp/jar and -H X-CSRF-Token: ....

Product Feedback

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

Submit it in Account Settings → "Product Feedback" and it will enter our monthly priority evaluation. Features that are adopted will be prominently acknowledged in the changelog.

Encountered A Bug

The "Help" button in the lower right corner raises a bug ticket, and the browser environment and latest execution ID are automatically attached. We usually respond within 24 hours.

Next

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