Installation

This guide will walk you through setting up Workflows and verifying your installation.

Before installing the Workflows SDK, ensure you have:

1. Python 3.12 or later installed
2. uv package manager installed

Install the Workflows package from PyPI using uv:

uv add mistralai-workflows

uv add mistralai-workflows

This will create a virtual environment (if one doesn't exist) and install Workflows along with its core dependencies.

Installing with Optional Dependencies

The Mistral plugin provides native integration with Mistral's AI models and services, including durable agents, tool calling, and multi-agent handoffs:

uv add "mistralai-workflows[mistralai]"

uv add "mistralai-workflows[mistralai]"

To verify your installation was successful, run the following command:

uv run python -c "import mistralai.workflows; print('Workflows is installed successfully!')"

uv run python -c "import mistralai.workflows; print('Workflows is installed successfully!')"

If you encounter any errors during this step, please check that your Python environment is properly configured.