Installation
Install the dynamiq Python package with pip or Poetry, check requirements, and set up provider API keys.
The SDK ships as a single PyPI package, dynamiq, with batteries included: LLM providers, vector-store clients, document converters, and the dynamiq CLI all come with the base install.
Requirements
- Python 3.10 – 3.13 (the package declares
>=3.10,<3.14). - API keys for the providers you plan to call (for example
OPENAI_API_KEY) — see Connections & credentials for the environment-variable conventions.
Install
pip install dynamiqpoetry add dynamiqgit clone https://github.com/dynamiq-ai/dynamiq.git
cd dynamiq
poetry installVerify the install and check the version:
python -c "from importlib.metadata import version; print(version('dynamiq'))"The base install also puts the dynamiq CLI on your PATH — see the CLI overview.
Optional extras
Two features have heavyweight dependencies that are not installed by default:
| Extra | Installs | Use case |
|---|---|---|
cua | cua-computer | Computer-use (desktop automation) tooling. Requires Python 3.12+. |
monty | pydantic-monty | The Monty-based Python code-execution tool. |
pip install "dynamiq[cua]"
pip install "dynamiq[monty]"Set your provider keys
Connection classes read credentials from environment variables by default, so most code samples in these docs work without passing keys explicitly:
export OPENAI_API_KEY="sk-..."
export ANTHROPIC_API_KEY="sk-ant-..."Keep keys in environment variables or a secrets manager — connection objects accept explicit api_key= arguments, but never commit literal keys to source control.