UiPath Flow — TypeScript Builder SDK

UiPath Flow orchestrations can be authored in TypeScript using the @uipath/maestro-builder-sdk package. The SDK provides a builder API to construct a Flow graph, allowing developers to define inputs, outputs, steps, and control flow in a type-safe manner. The graph is "compiled" down to a Flow JSON, which is the artifact used for executing the Flow on the UiPath platform. An existing Flow JSON can also be decompiled back into TypeScript for editing.

Before writing or editing any flow source, read references/author.md in full. It holds the critical rules this guide only summarizes, the scope gate, and the completion report the final response must follow.

Project layout

@uipath/maestro-builder-sdk is installed globally (npm install -g); examples/ contains authored examples, and references/ contains the details routed from this guide. A Flow is authored as .flow-sdk/<Name>.flow.ts inside its project folder <Solution>/<Name>/, and it imports the package directly.