CAMEL-AI Documentation home page
Search...
⌘K
CAMEL Home
GitHub
Join Community
Join Community
Search...
Navigation
Overview
API Reference
Documentation
API Reference
Website
Overview
API Reference
Agents
Camel.agents. types
Camel.agents. utils
Camel.agents.base
Camel.agents.chat agent
Camel.agents.critic agent
Camel.agents.deductive reasoner agent
Camel.agents.embodied agent
Camel.agents.knowledge graph agent
Camel.agents.mcp agent
Camel.agents.programmed agent instruction
Camel.agents.repo agent
Camel.agents.role assignment agent
Camel.agents.search agent
Camel.agents.task agent
Camel.agents.tool agents.base
Camel.agents.tool agents.hugging face tool agent
Configs
Camel.configs.aiml config
Camel.configs.anthropic config
Camel.configs.base config
Camel.configs.bedrock config
Camel.configs.cohere config
Camel.configs.crynux config
Camel.configs.deepseek config
Camel.configs.gemini config
Camel.configs.groq config
Camel.configs.internlm config
Camel.configs.litellm config
Camel.configs.lmstudio config
Camel.configs.mistral config
Camel.configs.modelscope config
Camel.configs.moonshot config
Camel.configs.netmind config
Camel.configs.novita config
Camel.configs.nvidia config
Camel.configs.ollama config
Camel.configs.openai config
Camel.configs.openrouter config
Camel.configs.ppio config
Camel.configs.qianfan config
Camel.configs.qwen config
Camel.configs.reka config
Camel.configs.samba config
Camel.configs.sglang config
Camel.configs.siliconflow config
Camel.configs.togetherai config
Camel.configs.vllm config
Camel.configs.watsonx config
Camel.configs.yi config
Camel.configs.zhipuai config
Data Generation
Camel.datagen.cot datagen
Camel.datagen.self improving cot
Camel.datagen.evol instruct.evol instruct
Camel.datagen.evol instruct.scorer
Camel.datagen.evol instruct.templates
Camel.datagen.self instruct.self instruct
Camel.datagen.source2synth.data processor
Camel.datagen.source2synth.models
Camel.datagen.source2synth.user data processor config
Datasets
Camel.datasets.base generator
Camel.datasets.few shot generator
Camel.datasets.models
Camel.datasets.self instruct generator
Camel.datasets.static dataset
Embeddings
Camel.embeddings.azure embedding
Camel.embeddings.base
Camel.embeddings.gemini embedding
Camel.embeddings.jina embedding
Camel.embeddings.mistral embedding
Camel.embeddings.openai compatible embedding
Camel.embeddings.openai embedding
Camel.embeddings.sentence transformers embeddings
Camel.embeddings.together embedding
Camel.embeddings.vlm embedding
Models
Camel.models. utils
Camel.models.aiml model
Camel.models.anthropic model
Camel.models.aws bedrock model
Camel.models.azure openai model
Camel.models.base audio model
Camel.models.base model
Camel.models.cohere model
Camel.models.crynux model
Camel.models.deepseek model
Camel.models.fish audio model
Camel.models.gemini model
Camel.models.groq model
Camel.models.internlm model
Camel.models.litellm model
Camel.models.lmstudio model
Camel.models.mistral model
Camel.models.model factory
Camel.models.model manager
Camel.models.modelscope model
Camel.models.moonshot model
Camel.models.nemotron model
Camel.models.netmind model
Camel.models.novita model
Camel.models.nvidia model
Camel.models.ollama model
Camel.models.openai audio models
Camel.models.openai compatible model
Camel.models.openai model
Camel.models.openrouter model
Camel.models.ppio model
Camel.models.qianfan model
Camel.models.qwen model
Camel.models.reka model
Camel.models.samba model
Camel.models.sglang model
Camel.models.siliconflow model
Camel.models.stub model
Camel.models.togetherai model
Camel.models.vllm model
Camel.models.volcano model
Camel.models.watsonx model
Camel.models.yi model
Camel.models.zhipuai model
Camel.models.reward.base reward model
Camel.models.reward.evaluator
Camel.models.reward.nemotron model
Camel.models.reward.skywork model
Interpreters
Camel.interpreters.base
Camel.interpreters.docker interpreter
Camel.interpreters.e2b interpreter
Camel.interpreters.internal python interpreter
Camel.interpreters.ipython interpreter
Camel.interpreters.subprocess interpreter
Memory
Camel.memories.agent memories
Camel.memories.base
Camel.memories.records
Camel.memories.blocks.chat history block
Camel.memories.blocks.vectordb block
Camel.memories.context creators.score based
Messages
Camel.messages.base
Camel.messages.func message
Camel.messages.conversion.alpaca
Camel.messages.conversion.conversation models
Prompts
Camel.prompts.ai society
Camel.prompts.base
Camel.prompts.code
Camel.prompts.evaluation
Camel.prompts.generate text embedding data
Camel.prompts.image craft
Camel.prompts.misalignment
Camel.prompts.persona hub
Camel.prompts.prompt templates
Camel.prompts.role description prompt template
Camel.prompts.solution extraction
Camel.prompts.task prompt template
Camel.prompts.translation
Camel.prompts.video description prompt
Responses
Camel.responses.agent responses
Retrievers
Camel.retrievers.auto retriever
Camel.retrievers.base
Camel.retrievers.bm25 retriever
Camel.retrievers.cohere rerank retriever
Camel.retrievers.hybrid retrival
Camel.retrievers.vector retriever
Societies
Camel.societies.babyagi playing
Camel.societies.role playing
Camel.societies.workforce.base
Camel.societies.workforce.role playing worker
Camel.societies.workforce.single agent worker
Camel.societies.workforce.structured output handler
Camel.societies.workforce.task channel
Camel.societies.workforce.utils
Camel.societies.workforce.worker
Camel.societies.workforce.workforce
Camel.societies.workforce.workforce logger
Storage
Camel.storages.graph storages.base
Camel.storages.graph storages.graph element
Camel.storages.graph storages.nebula graph
Camel.storages.graph storages.neo4j graph
Camel.storages.key value storages.base
Camel.storages.key value storages.in memory
Camel.storages.key value storages.json
Camel.storages.key value storages.mem0 cloud
Camel.storages.key value storages.redis
Camel.storages.object storages.amazon s3
Camel.storages.object storages.azure blob
Camel.storages.object storages.base
Camel.storages.object storages.google cloud
Camel.storages.vectordb storages.base
Camel.storages.vectordb storages.chroma
Camel.storages.vectordb storages.faiss
Camel.storages.vectordb storages.milvus
Camel.storages.vectordb storages.oceanbase
Camel.storages.vectordb storages.pgvector
Camel.storages.vectordb storages.qdrant
Camel.storages.vectordb storages.surreal
Camel.storages.vectordb storages.tidb
Camel.storages.vectordb storages.weaviate
Tasks
Camel.tasks.task
Terminators
Camel.terminators.base
Camel.terminators.response terminator
Camel.terminators.token limit terminator
Toolkits
Camel.toolkits.aci toolkit
Camel.toolkits.arxiv toolkit
Camel.toolkits.ask news toolkit
Camel.toolkits.async browser toolkit
Camel.toolkits.audio analysis toolkit
Camel.toolkits.base
Camel.toolkits.bohrium toolkit
Camel.toolkits.browser toolkit
Camel.toolkits.browser toolkit commons
Camel.toolkits.code execution
Camel.toolkits.craw4ai toolkit
Camel.toolkits.dalle toolkit
Camel.toolkits.dappier toolkit
Camel.toolkits.data commons toolkit
Camel.toolkits.edgeone pages mcp toolkit
Camel.toolkits.excel toolkit
Camel.toolkits.file write toolkit
Camel.toolkits.function tool
Camel.toolkits.github toolkit
Camel.toolkits.google calendar toolkit
Camel.toolkits.google drive mcp toolkit
Camel.toolkits.google maps toolkit
Camel.toolkits.google scholar toolkit
Camel.toolkits.human toolkit
Camel.toolkits.image analysis toolkit
Camel.toolkits.jina reranker toolkit
Camel.toolkits.klavis toolkit
Camel.toolkits.linkedin toolkit
Camel.toolkits.markitdown toolkit
Camel.toolkits.math toolkit
Camel.toolkits.mcp toolkit
Camel.toolkits.memory toolkit
Camel.toolkits.meshy toolkit
Camel.toolkits.message agent toolkit
Camel.toolkits.message integration
Camel.toolkits.mineru toolkit
Camel.toolkits.networkx toolkit
Camel.toolkits.note taking toolkit
Camel.toolkits.notion mcp toolkit
Camel.toolkits.notion toolkit
Camel.toolkits.open api toolkit
Camel.toolkits.openai agent toolkit
Camel.toolkits.openai image toolkit
Camel.toolkits.openbb toolkit
Camel.toolkits.origene mcp toolkit
Camel.toolkits.playwright mcp toolkit
Camel.toolkits.pptx toolkit
Camel.toolkits.pubmed toolkit
Camel.toolkits.pulse mcp search toolkit
Camel.toolkits.pyautogui toolkit
Camel.toolkits.reddit toolkit
Camel.toolkits.retrieval toolkit
Camel.toolkits.screenshot toolkit
Camel.toolkits.search toolkit
Camel.toolkits.searxng toolkit
Camel.toolkits.semantic scholar toolkit
Camel.toolkits.slack toolkit
Camel.toolkits.stripe toolkit
Camel.toolkits.sympy toolkit
Camel.toolkits.task planning toolkit
Camel.toolkits.terminal toolkit
Camel.toolkits.thinking toolkit
Camel.toolkits.twitter toolkit
Camel.toolkits.video analysis toolkit
Camel.toolkits.video download toolkit
Camel.toolkits.weather toolkit
Camel.toolkits.web deploy toolkit
Camel.toolkits.whatsapp toolkit
Camel.toolkits.wolfram alpha toolkit
Camel.toolkits.zapier toolkit
Camel.toolkits.hybrid browser toolkit.actions
Camel.toolkits.hybrid browser toolkit.agent
Camel.toolkits.hybrid browser toolkit.browser session
Camel.toolkits.hybrid browser toolkit.config loader
Camel.toolkits.hybrid browser toolkit.hybrid browser toolkit
Camel.toolkits.hybrid browser toolkit.hybrid browser toolkit ts
Camel.toolkits.hybrid browser toolkit.snapshot
Camel.toolkits.hybrid browser toolkit.stealth config
Camel.toolkits.hybrid browser toolkit.ws wrapper
Camel.toolkits.hybrid browser toolkit py.actions
Camel.toolkits.hybrid browser toolkit py.agent
Camel.toolkits.hybrid browser toolkit py.browser session
Camel.toolkits.hybrid browser toolkit py.config loader
Camel.toolkits.hybrid browser toolkit py.hybrid browser toolkit
Camel.toolkits.hybrid browser toolkit py.snapshot
Camel.toolkits.non visual browser toolkit.actions
Camel.toolkits.non visual browser toolkit.agent
Camel.toolkits.non visual browser toolkit.browser non visual toolkit
Camel.toolkits.non visual browser toolkit.nv browser session
Camel.toolkits.non visual browser toolkit.snapshot
Types
Camel.types.enums
Camel.types.mcp registries
Camel.types.unified model type
Camel.types.agents.tool calling record
Verifiers
Camel.verifiers.base
Camel.verifiers.math verifier
Camel.verifiers.models
Camel.verifiers.physics verifier
Camel.verifiers.python verifier
Bots
Camel.bots.telegram bot
Camel.bots.discord.discord app
Camel.bots.discord.discord installation
Camel.bots.discord.discord store
Camel.bots.slack.models
Camel.bots.slack.slack app
Utilities
Camel.utils.async func
Camel.utils.commons
Camel.utils.deduplication
Camel.utils.filename
Camel.utils.langfuse
Camel.utils.mcp
Camel.utils.mcp client
Camel.utils.message summarizer
Camel.utils.response format
Camel.utils.token counting
Camel.utils.tool result
Camel.utils.chunker.base
Camel.utils.chunker.code chunker
Camel.utils.chunker.uio chunker
Environments
Camel.environments.models
Camel.environments.multi step
Camel.environments.rlcards env
Camel.environments.single step
Camel.environments.tic tac toe
Extractors
Camel.extractors.base
Camel.extractors.python strategies
Personas
Camel.personas.persona
Camel.personas.persona hub
Benchmarks
Camel.benchmarks.apibank
Camel.benchmarks.apibench
Camel.benchmarks.base
Camel.benchmarks.browsecomp
Camel.benchmarks.gaia
Camel.benchmarks.nexus
Camel.benchmarks.ragbench
Camel.benchmarks.mock website.app
Camel.benchmarks.mock website.mock web
Data Collectors
Camel.data collectors.alpaca collector
Camel.data collectors.base
Camel.data collectors.sharegpt collector
Datahubs
Camel.datahubs.base
Camel.datahubs.huggingface
Loaders
Camel.loaders.apify reader
Camel.loaders.base io
Camel.loaders.base loader
Camel.loaders.chunkr reader
Camel.loaders.crawl4ai reader
Camel.loaders.firecrawl reader
Camel.loaders.jina url reader
Camel.loaders.markitdown
Camel.loaders.mineru extractor
Camel.loaders.mistral reader
Camel.loaders.pandas reader
Camel.loaders.scrapegraph reader
Camel.loaders.unstructured io
Runtimes
Camel.runtimes.base
Camel.runtimes.configs
Camel.runtimes.daytona runtime
Camel.runtimes.docker runtime
Camel.runtimes.llm guard runtime
Camel.runtimes.remote http runtime
Camel.runtimes.ubuntu docker runtime
Camel.runtimes.utils.function risk toolkit
Camel.runtimes.utils.ignore risk toolkit
Schemas
Camel.schemas.base
Camel.schemas.openai converter
Camel.schemas.outlines converter
On this page
CAMEL-AI API Reference
Overview
Core Modules
🤖 Agents
🧠 Models
💬 Messages
🧩 Prompts
🔧 Toolkits
Data & Storage
📊 Datasets
🗄️ Storage
🔍 Retrievers
📝 Memory
Advanced Features
🏢 Societies
⚙️ Runtime
🔌 Interpreters
📥 Loaders
Configuration & Types
⚙️ Configs
🏷️ Types
📐 Schemas
Utilities & Extensions
🛠️ Utilities
🔍 Verifiers
🏁 Terminators
🌐 Environments
Specialized Components
🤖 Bots
📊 Benchmarks
🎭 Personas
🔄 Data Generation
📚 Data Collector
🏢 Datahubs
🧩 Extractors
🔗 Embeddings
Getting Started
Need Help?
Overview
API Reference
Complete API documentation for CAMEL-AI framework
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
Choose your use case
: Browse the modules above to find components relevant to your project
Check examples
: Each module page includes usage examples and code snippets
Explore integrations
: See how different modules work together in the
Cookbooks
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
.
Camel.agents. types
Assistant
Responses are generated using AI and may contain mistakes.