​

CAMEL-AI API Reference

Welcome to the comprehensive API reference for CAMEL-AI, a powerful framework for building multi-agent systems and AI applications.

​

Overview

CAMEL-AI provides a rich set of modules and components to help you build sophisticated AI agents and multi-agent systems. This API reference covers all the core modules, utilities, and tools available in the framework.

​

Core Modules

​

🤖 Agents

Build and manage AI agents with various capabilities including chat agents, critic agents, and specialized tool agents.

​

🧠 Models

Interface with various language models from different providers including OpenAI, Anthropic, Google, and more.

​

💬 Messages

Handle message formatting, conversion, and management for agent communications.

​

🧩 Prompts

Access pre-built prompt templates and create custom prompts for different use cases.

​

🔧 Toolkits

Extend agent capabilities with a comprehensive collection of tools for web search, file operations, APIs, and more.

​

Data & Storage

​

📊 Datasets

Generate and manage datasets for training and evaluation purposes.

​

🗄️ Storage

Store and retrieve data using various storage backends including vector databases, key-value stores, and object storage.

​

🔍 Retrievers

Implement retrieval-augmented generation (RAG) with various retrieval strategies.

​

📝 Memory

Manage agent memory and context for long-running conversations.

​

Advanced Features

​

🏢 Societies

Create multi-agent societies with role-playing capabilities and complex interactions.

​

⚙️ Runtime

Execute code and manage runtime environments for agent operations.

​

🔌 Interpreters

Run code in various environments including Python, Docker, and cloud platforms.

​

📥 Loaders

Load and process data from various sources including web pages, documents, and APIs.

​

Configuration & Types

​

⚙️ Configs

Configure models and services with provider-specific settings.

​

🏷️ Types

Type definitions and enumerations used throughout the framework.

​

📐 Schemas

Define and validate data structures for structured outputs.

​

Utilities & Extensions

​

🛠️ Utilities

Common utility functions for various operations.

​

🔍 Verifiers

Verify and validate outputs from agents and models.

​

🏁 Terminators

Control when conversations and processes should end.

​

🌐 Environments

Simulate environments for agent interactions and testing.

​

Specialized Components

​

🤖 Bots

Deploy agents as bots on various platforms like Discord, Slack, and Telegram.

​

📊 Benchmarks

Evaluate agent performance using standardized benchmarks.

​

🎭 Personas

Create and manage agent personas for role-playing scenarios.

​

🔄 Data Generation

Generate synthetic data for training and evaluation.

​

📚 Data Collector

Collect and process data from various sources.

​

🏢 Datahubs

Manage data repositories and hubs.

​

🧩 Extractors

Extract structured information from unstructured data.

​

🔗 Embeddings

Generate and work with text embeddings from various providers.

​

Getting Started

1. Choose your use case: Browse the modules above to find components relevant to your project
2. Check examples: Each module page includes usage examples and code snippets
3. Explore integrations: See how different modules work together in the Cookbooks
4. Join the community: Get help and share your projects on our Discord

​

Need Help?

• 📖 Documentation: Start with our Getting Started guide
• 🍳 Cookbooks: Check out practical examples in our Cookbooks section
• 💬 Community: Join our Discord community for support
• 🐛 Issues: Report bugs on GitHub

---

This API reference is automatically generated from the CAMEL-AI codebase. For the latest updates, visit our GitHub repository.