Skip to content

🚀 Get Started in Under 5 Minutes

Clone the repository, configure your API key, and run your first intelligent agent. You'll just need one OPENROUTER_API_KEY.

📋 Prerequisites

System Requirements

⚡ Quick Setup

Example 1: Intelligent document analysis with file processing capabilities

File Processing Demo

This example demonstrates MiroFlow's document analysis capabilities.

Setup Commands
# 1. Clone and setup
git clone https://github.com/MiroMindAI/MiroFlow && cd MiroFlow
uv sync

# 2. Configure API key
cp .env.template .env
# Edit .env and add your OPENROUTER_API_KEY

# 3. Run your first agent
uv run main.py trace --config_file_name=agent_quickstart_1 --task="What is the first country listed in the XLSX file that have names starting with Co?" --task_file_name="data/FSI-2023-DOWNLOAD.xlsx"

Expected Output

🎉 Expected Output: Your agent should return \boxed{Congo Democratic Republic} 😊

Troubleshooting

💡 Tip: If you encounter issues, check that your API key is correctly set in the .env file and that all dependencies are installed.

Coming Soon

Coming Soon: We will add a video demo for this example

Example 2: Web research and multi-agent orchestration

Work in Progress

The example is not complete yet, to be completed

Web Research Command
uv run main.py trace --config_file_name=agent_quickstart_2 --task="What is the Nasdaq Composite Index at today?"

Coming Soon

Coming Soon: Web research and multi-agent orchestration example

Documentation Info

Last Updated: Sep 2025 · Doc Contributor: Team @ MiroMind AI