UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip api-workflow run

Syntax and options for `uip api-workflow run`, which executes an API Workflow JSON file locally using the bundled Serverless Workflow executor.

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​

FlagDescription
-i, --input-arguments <json>Input arguments as a JSON string, for example '{"name": "World"}'.
--input-file <name=path>Upload a local file and pass it as the file (JobAttachment) input <name>. Repeatable for multiple files. Needs a signed-in session.
--output-dir <dir>Download every file (JobAttachment) reference in the workflow output into <dir>; each downloaded reference gains a LocalPath. Needs a signed-in session.
--folder-key <guid>Orchestrator folder key for the attachments this run creates (uploaded inputs and files written by the File to Base64 / Base64 to File activities).
--no-authSkip credential loading. The workflow runs in a local-only mode with no access to connectors or cloud-backed services. Refer to Local-only mode.

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 a single output field
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}' \
    --output-filter 'greeting'

# Upload a local file as a file (JobAttachment) input, and download any file
# outputs the workflow produces
uip api-workflow run ./workflow.json \
    --input-file document=./invoice.pdf \
    --output-dir ./out
# 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 a single output field
uip api-workflow run ./workflow.json \
    --input-arguments '{"name":"World"}' \
    --output-filter 'greeting'

# Upload a local file as a file (JobAttachment) input, and download any file
# outputs the workflow produces
uip api-workflow run ./workflow.json \
    --input-file document=./invoice.pdf \
    --output-dir ./out

Local-only mode​

With --no-auth, the command refuses to run when the run needs Orchestrator blob storage:

  • --input-file is passed.
  • --output-dir is passed.
  • The workflow uses the File to Base64 or Base64 to File activities.

Each refusal returns Result: "Failure" with Instructions to run uip login and drop --no-auth.

Data shape (--output json)​

Data is the workflow's own output, with field names kept exactly as the workflow produces them:

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

A workflow that produces no output returns Data: { "Message": "(no output)" }.

When --output-dir is set, each file (JobAttachment) reference in the output is downloaded and gains a LocalPath:

{
  "Code": "WorkflowRun",
  "Data": {
    "encoded": {
      "ID": "6f1c0d2e-8a1b-4c3d-9e0f-123456789abc",
      "FullName": "invoice.base64",
      "MimeType": "text/plain",
      "LocalPath": "/abs/path/out/invoice.base64"
    }
  }
}
{
  "Code": "WorkflowRun",
  "Data": {
    "encoded": {
      "ID": "6f1c0d2e-8a1b-4c3d-9e0f-123456789abc",
      "FullName": "invoice.base64",
      "MimeType": "text/plain",
      "LocalPath": "/abs/path/out/invoice.base64"
    }
  }
}

Without --output-dir, the reference is returned without a local file.

A failed run exits non-zero per the standard exit codes and returns Result: "Failure" with the cause in Message and the next step in Instructions. When the workflow completed but its output files could not be downloaded, the failure also carries the workflow output in Data, so the attachment IDs are kept.

See also​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated