UiPath CLI user guide

Last updated May 7, 2026

uip api-workflow run

uip api-workflow run executes an API Workflow JSON file locally using the bundled Serverless Workflow executor. Input arguments are passed as JSON. By default, the executor loads UiPath credentials from the uip login session so the workflow can reach connectors and cloud-backed services; pass --no-auth to skip credential loading and run in a local-only mode.

Synopsis

uip api-workflow run <file> [options]
uip api-workflow run <file> [options]

<file> — path to the workflow JSON file.

Options

Flag	Description
`-i, --input-arguments <json>`	Input arguments as a JSON string, for example `'{"name": "World"}'`.
`--no-auth`	Skip credential loading. The workflow runs in a local-only mode with no access to connectors or cloud-backed services.

Examples

# Run with an inline input object
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}'

# Run without loading credentials (offline / local-only)
uip api-workflow run ./workflow.json --no-auth

# Extract just the output payload
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}' \
    --output-filter 'Data.Output'
# Run with an inline input object
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}'

# Run without loading credentials (offline / local-only)
uip api-workflow run ./workflow.json --no-auth

# Extract just the output payload
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}' \
    --output-filter 'Data.Output'

Data shape (--output json)

{
  "Code": "WorkflowRun",
  "Data": {
    "Status": "Completed",
    "Output": {
      "greeting": "Hello, World!"
    }
  }
}
{
  "Code": "WorkflowRun",
  "Data": {
    "Status": "Completed",
    "Output": {
      "greeting": "Hello, World!"
    }
  }
}

Status reflects the executor's terminal state (Completed, Faulted, etc.). A faulted run exits non-zero per the standard exit codes.

uip api-workflow build — compile the project before running it.
uip api-workflow pack — package a validated workflow for publication.

Was this page helpful?

PREVIOUSbuild

NEXTuip codedagent

UiPath CLI user guide

Synopsis​

Options​

Examples​

Data shape (--output json)​

Related​

See also​

Was this page helpful?

Synopsis

Options

Examples

Data shape (--output json)

Related

See also