# 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`](./uip-login.md) 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.

`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`](./uip-login.md) 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]
```

- `<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

```bash
# 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)

```json
{
  "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](./exit-codes.md).

## Related

- [uip api-workflow build](./uip-api-workflow-build.md) — compile the project before running it.
- [uip api-workflow pack](./uip-api-workflow-pack.md) — package a validated workflow for publication.

## See also

- [API Workflow tool overview](./uip-api-workflow.md)
- [Global options](./global-options.md)
- [Exit codes](./exit-codes.md)
- [`uip login`](./uip-login.md) — credentials loaded by `run` unless `--no-auth` is set.
