uip api-workflow

uip api-workflow runs UiPath API Workflows locally and packages them for publication. API Workflows are the Serverless Workflow-based execution model used for orchestration code that does not ship as an RPA process. The run verb executes a workflow JSON on your machine — useful for local iteration before publishing — while build and pack produce a .nupkg ready to upload. Install it with uip tools install api-workflow, or invoke uip api-workflow … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation. api-workflow is the command prefix; the underlying package is @uipath/api-workflow-tool.

Commands

Every uip api-workflow verb has its own reference page. For live argument lists on your installed tool version, run uip api-workflow <verb> --help.

Verb	Description
pack	Build and package an API Workflow project into a .nupkg.
build	Compile an API Workflow project without packaging it.
run	Execute an API Workflow JSON file locally using the bundled Serverless Workflow executor.

Synopsis

uip api-workflow pack  <projectPath> <destinationPath> [options]
uip api-workflow build <projectPath>
uip api-workflow run   <file> [options]

All uip api-workflow verbs honor the global options (--output, --output-filter, --log-level, --log-file). Standard exit codes apply.

See also

• Tools (plugins) — install model for @uipath/api-workflow-tool.
• uip login — credentials that run loads unless you pass --no-auth.
• Configuration — credential precedence for the run loader.