DataBraid Documentation
DataBraid is a visual workflow system. A Braid is a versioned graph; a Bead is one processing unit with declared ports, configuration and runtime capabilities. The editor creates the document, but real runs execute on the server.
Choose a path
| Goal | Start here |
|---|---|
| Learn visually | Demo Braid learning path |
| Build and debug | Builder workflows |
| Understand execution | System architecture |
| Integrate a service | Public API |
| Inspect a Bead contract | Bead reference |
| Add a Bead | Extension guide |
| Deploy and maintain | Operations |
Information architecture
Text alternative: the overview leads to builder tutorials and how-to guides; deeper sections explain architecture, API contracts, Bead references, extension work, operations and roadmap status.
Core guarantees
- Provider credentials remain server-side and are referenced by name.
- A Braid may have public input, public output, both or neither.
- Browser sinks display server results without moving execution into the browser.
- Every editor test and webhook invocation produces an observable run.
- Typed ports improve validation while legacy
anycontracts remain migratable.
Quick reference
- Editor tests: session-authenticated
POST /api/runs. - Supported public execution: Bearer-authenticated
POST /api/braid/{id}. - Public output:
200; successful effect-only Braid:204. - Run correlation:
X-DataBraid-Run-Id.