Get started with CAMEL-AI - Install, configure, and build your first multi-agent system
Python Version Requirements
CAMEL-AI requires Python >=3.10 and <=3.12
. Here’s how to check your version:
If you need to update Python, visit python.org/downloads
CAMEL-AI supports multiple installation methods to suit different development workflows. Choose the method that best fits your needs.
Install CAMEL-AI 🐪
Basic Installation:
Install the core CAMEL library:
Full Installation (Recommended):
Install CAMEL with all features and dependencies:
Some features may not work without their required dependencies. Install camel-ai[all]
to ensure all dependencies are available, or install specific extras based on the features you need.
Custom Installation:
Available extras for specific use cases:
all
: Includes all features belowmodel_platforms
: OpenAI, Google, Mistral, Anthropic Claude, Cohere etc.huggingface
: Transformers, Diffusers, Accelerate, Datasets, PyTorch etc.rag
: Sentence Transformers, Qdrant, Milvus, TiDB, BM25, OceanBase, Weaviate, chroma etc.storage
: Neo4j, Redis, Azure Blob, Google Cloud Storage, AWS S3 etc, Pgvector.web_tools
: DuckDuckGo, Wikipedia, WolframAlpha, Google Maps, Weather API etc.document_tools
: PDF, Word, OpenAPI, BeautifulSoup, Unstructured etc.media_tools
: Image Processing, Audio Processing, YouTube Download, FFmpeg etc.communication_tools
: Slack, Discord, Telegram, GitHub, Reddit, Notion etc.data_tools
: Pandas, TextBlob, DataCommons, OpenBB, Stripe etc.research_tools
: arXiv, Google Scholar etc.dev_tools
: Docker, Jupyter, Tree-sitter, Code Interpreter etc.Multiple extras can be combined:
To verify that camel-ai
is installed, run:
We recommend starting with a simple role-playing scenario to understand CAMEL’s multi-agent capabilities. Here’s how to get started:
Set Up Your Project Structure
Configure Your Environment
Create a .env
file with your API keys:
Create a requirements.txt
file:
Install Dependencies and Run
Install project dependencies:
Set up your environment variables by loading the .env
file:
Run your first multi-agent example:
Want to see multi-agent collaboration at scale? Try running the workforce example:
python examples/workforce/multiple_single_agents.py
CAMEL-AI offers multiple installation approaches for different development needs:
Learn about contributing to CAMEL-AI and development best practices
Set Default Model Configuration
Configure default model platform and type using environment variables:
By default, CAMEL uses:
Set Up API Keys
For Bash shell (Linux, macOS, Git Bash on Windows):
For Windows Command Prompt:
For Windows PowerShell:
Using .env File (Recommended):
Load in Python:
After setting up your API keys, explore CAMEL’s capabilities:
Run the test suite to ensure everything is working:
Follow our quickstart guide to create role-playing agents and see CAMEL in action.
Discover RAG systems, tool integration, and complex multi-agent cookbooks.
Connect with other developers, contribute, and share your CAMEL experiences.
Dive deep into CAMEL’s API and advanced configuration options.
For additional feature examples and use cases, explore the examples
directory in the CAMEL repository.