- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
Commands for running UiPath API Workflows locally and packaging them for publication, using the `uip api-workflow` tool.
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 |
|---|---|
init | Scaffold a new API Workflow project with boilerplate files. |
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. |
validate | Validate an API Workflow JSON file's structure. |
bindings | Generate a bindings_v2.json file from a workflow, for solutions authored outside Studio Web. |
registry | Look up connector/DAP activities and emit ready-to-paste activity stubs. |
Synopsis
uip api-workflow init <name> [options]
uip api-workflow pack <projectPath> <destinationPath> [options]
uip api-workflow build <projectPath>
uip api-workflow run <file> [options]
uip api-workflow validate <file> [options]
uip api-workflow bindings sync --workflow <path>
uip api-workflow registry resolve <keyword> [options]
uip api-workflow registry stub <activity-type-id> [options]
uip api-workflow init <name> [options]
uip api-workflow pack <projectPath> <destinationPath> [options]
uip api-workflow build <projectPath>
uip api-workflow run <file> [options]
uip api-workflow validate <file> [options]
uip api-workflow bindings sync --workflow <path>
uip api-workflow registry resolve <keyword> [options]
uip api-workflow registry stub <activity-type-id> [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 thatrunloads unless you pass--no-auth.- Configuration — credential precedence for the
runloader.