Arazzo Runner – Getting Started¶
Arazzo Runner is the workflow execution engine for running API workflows defined in the Arazzo specification and API operations defined in OpenAPI. It powers agents and automation by orchestrating multi-step API flows with authentication, dynamic parameters, and reusable logic.
Status: Beta – actively evolving. Contributions and feedback are welcome.
Quick Start (60 seconds)¶
- Install
pip install arazzo-runner
or
uv add arazzo-runner
- Run a workflow
uvx arazzo-runner execute-workflow ./myworkflow.arazzo.yaml \
--workflow-id myWorkflow \
--inputs '{"param1": "value1"}'
- List workflows
uvx arazzo-runner list-workflows ./myworkflow.arazzo.yaml
- Show authentication variables
uvx arazzo-runner show-env-mappings ./myworkflow.arazzo.yaml
Key Features¶
- Execute Arazzo workflows or individual OpenAPI operations
- Automatic authentication handling (API Key, OAuth2, Basic/Bearer)
- Dynamic server URL resolution
- Blob storage support for large binary payloads
- CLI + Python API for flexible integration
Learn More¶
- CLI Reference: Arazzo Runner Commands
- Arazzo Spec: Arazzo Format Documentation
- Examples: Runner Examples
Contributing¶
Arazzo Runner is open source. If you’d like to:
- Report a bug
- Request a feature
- Improve docs or examples
Open an issue in the repo → jentic/arazzo-engine