Praison AI agents for completing complex tasks with Self Reflection Agents
Project description
PraisonAI ๐ฆ โ Automate and solve complex challenges with AI agent teams that plan, research, code, and deliver results to Telegram, Discord, and WhatsApp โ running 24/7. A low-code, production-ready multi-agent framework with handoffs, guardrails, memory, RAG, and 100+ LLM providers, built around simplicity, customisation, and effective human-agent collaboration.
โโโโโโโ โโโโโโโ โโโโโโ โโโโโโโโโโโ โโโโโโโ โโโโ โโโ โโโโโโ โโโ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โโโ โโโโโโโโโโโ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โโโโโโโโโ โโโ โโโโโโโโโโโ
โโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโ โโโโโโโโโโโ
โโโ โโโ โโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโโโ โโโโโโ โโโ โโโโโโ
โโโ โโโ โโโโโโ โโโโโโโโโโโโโโ โโโโโโโ โโโ โโโโโ โโโ โโโโโโ
pip install praisonai
* export TAVILY_API_KEY=xxxxx
Quick Paths:
- ๐ New here? โ Quick Start (1 minute to first agent)
- ๐ฆ Installing? โ Installation
- ๐ Python SDK? โ Python Examples
- ๐ YAML/No-Code? โ YAML Examples
- ๐ฏ CLI user? โ CLI Quick Reference
- ๐ค Contributing? โ Contributing
โก Performance
PraisonAI is built for speed, with agent instantiation in under 4ฮผs. This reduces overhead, improves responsiveness, and helps multi-agent systems scale efficiently in real-world production workloads.
| Performance Metric | PraisonAI |
|---|---|
| Avg Instantiation Time | 3.77 ฮผs |
๐ฏ Use Cases
AI agents solving real-world problems across industries:
| Use Case | Description |
|---|---|
| ๐ Research & Analysis | Conduct deep research, gather information, and generate insights from multiple sources automatically |
| ๐ป Code Generation | Write, debug, and refactor code with AI agents that understand your codebase and requirements |
| โ๏ธ Content Creation | Generate blog posts, documentation, marketing copy, and technical writing with multi-agent teams |
| ๐ Data Pipelines | Extract, transform, and analyze data from APIs, databases, and web sources automatically |
| ๐ค Customer Support | Deploy 24/7 support bots on Telegram, Discord, Slack with memory and knowledge-backed responses |
| โ๏ธ Workflow Automation | Automate multi-step business processes with agents that hand off tasks, verify results, and self-correct |
Supported Providers
PraisonAI supports 100+ LLM providers through seamless integration:
View all 24 providers with examples
| Provider | Example |
|---|---|
| OpenAI | Example |
| Anthropic | Example |
| Google Gemini | Example |
| Ollama | Example |
| Groq | Example |
| DeepSeek | Example |
| xAI Grok | Example |
| Mistral | Example |
| Cohere | Example |
| Perplexity | Example |
| Fireworks | Example |
| Together AI | Example |
| OpenRouter | Example |
| HuggingFace | Example |
| Azure OpenAI | Example |
| AWS Bedrock | Example |
| Google Vertex | Example |
| Databricks | Example |
| Cloudflare | Example |
| AI21 | Example |
| Replicate | Example |
| SageMaker | Example |
| Moonshot | Example |
| vLLM | Example |
๐ Why PraisonAI?
| Feature | How | |
|---|---|---|
| ๐ | MCP Protocol โ stdio, HTTP, WebSocket, SSE | tools=MCP("npx ...") |
| ๐ง | Planning Mode โ plan โ execute โ reason | planning=True |
| ๐ | Deep Research โ multi-step autonomous research | Docs |
| ๐ค | External Agents โ orchestrate Claude Code, Gemini CLI, Codex | Docs |
| ๐ | Agent Handoffs โ seamless conversation passing | handoff=True |
| ๐ก๏ธ | Guardrails โ input/output validation | Docs |
| Web Search + Fetch โ native browsing | web_search=True |
|
| ๐ช | Self Reflection โ agent reviews its own output | Docs |
| ๐ | Workflow Patterns โ route, parallel, loop, repeat | Docs |
| ๐ง | Memory (zero deps) โ works out of the box | memory=True |
View all 25 features
| Feature | How | |
|---|---|---|
| ๐ก | Prompt Caching โ reduce latency + cost | prompt_caching=True |
| ๐พ | Sessions + Auto-Save โ persistent state across restarts | auto_save="my-project" |
| ๐ญ | Thinking Budgets โ control reasoning depth | thinking_budget=1024 |
| ๐ | RAG + Quality-Based RAG โ auto quality scoring retrieval | Docs |
| ๐ | Model Router โ auto-routes to cheapest capable model | Docs |
| ๐ง | Shadow Git Checkpoints โ auto-rollback on failure | Docs |
| ๐ก | A2A Protocol โ agent-to-agent interop | Docs |
| ๐ | Context Compaction โ never hit token limits | Docs |
| ๐ก | Telemetry โ OpenTelemetry traces, spans, metrics | Docs |
| ๐ | Policy Engine โ declarative agent behavior control | Docs |
| ๐ | Background Tasks โ fire-and-forget agents | Docs |
| ๐ | Doom Loop Detection โ auto-recovery from stuck agents | Docs |
| ๐ธ๏ธ | Graph Memory โ Neo4j-style relationship tracking | Docs |
| ๐๏ธ | Sandbox Execution โ isolated code execution | Docs |
| ๐ฅ๏ธ | Bot Gateway โ multi-agent routing across channels | Docs |
"Grok 3 customer support" โ Elon Musk quoting PraisonAI's tutorial
๐ Quick Start
Get started with PraisonAI in under 1 minute:
# Install
pip install praisonaiagents
# Set API key
export OPENAI_API_KEY=your_key_here
# Create a simple agent
python -c "from praisonaiagents import Agent; Agent(instructions='You are a helpful AI assistant').start('Write a haiku about AI')"
Next Steps: Single Agent Example | Multi Agents | Full Docs
๐ฆ Installation
Python SDK
Lightweight package dedicated for coding:
pip install praisonaiagents
For the full framework with CLI support:
pip install praisonai
๐ฆ PraisonAI Claw โ full UI with bots, memory, knowledge, and gateway:
pip install "praisonai[claw]"
praisonai claw
๐ PraisonAI Flow โ Langflow Visual Flow Builder:
pip install "praisonai[flow]"
praisonai flow
๐ค PraisonAI UI โ Clean chat interface:
pip install "praisonai[ui]"
praisonai ui
JavaScript SDK
npm install praisonai
๐ Using Python Code
1. Single Agent
from praisonaiagents import Agent
agent = Agent(instructions="You are a helpful AI assistant")
agent.start("Write a movie script about a robot in Mars")
2. Multi Agents
from praisonaiagents import Agent, Agents
research_agent = Agent(instructions="Research about AI")
summarise_agent = Agent(instructions="Summarise research agent's findings")
agents = Agents(agents=[research_agent, summarise_agent])
agents.start()
3. MCP (Model Context Protocol)
from praisonaiagents import Agent, MCP
# stdio - Local NPX/Python servers
agent = Agent(tools=MCP("npx @modelcontextprotocol/server-memory"))
# Streamable HTTP - Production servers
agent = Agent(tools=MCP("https://api.example.com/mcp"))
# WebSocket - Real-time bidirectional
agent = Agent(tools=MCP("wss://api.example.com/mcp", auth_token="token"))
# With environment variables
agent = Agent(
tools=MCP(
command="npx",
args=["-y", "@modelcontextprotocol/server-brave-search"],
env={"BRAVE_API_KEY": "your-key"}
)
)
๐ Full MCP docs โ stdio, HTTP, WebSocket, SSE transports
4. Custom Tools
from praisonaiagents import Agent, tool
@tool
def search(query: str) -> str:
"""Search the web for information."""
return f"Results for: {query}"
@tool
def calculate(expression: str) -> float:
"""Evaluate a math expression."""
return eval(expression)
agent = Agent(
instructions="You are a helpful assistant",
tools=[search, calculate]
)
agent.start("Search for AI news and calculate 15*4")
๐ Full tools docs โ BaseTool, tool packages, 100+ built-in tools
5. Persistence (Databases)
from praisonaiagents import Agent, db
agent = Agent(
name="Assistant",
db=db(database_url="postgresql://localhost/mydb"),
session_id="my-session"
)
agent.chat("Hello!") # Auto-persists messages, runs, traces
๐ Full persistence docs โ PostgreSQL, MySQL, SQLite, MongoDB, Redis, and 20+ more
6. PraisonAI Claw ๐ฆ (Dashboard UI)
Connect your AI agents to Telegram, Discord, Slack, WhatsApp and more โ all from a single command.
pip install "praisonai[claw]"
praisonai claw
Open http://localhost:8082 โ the dashboard comes with 13 built-in pages: Chat, Agents, Memory, Knowledge, Channels, Guardrails, Cron, and more. Add messaging channels directly from the UI.
๐ Full Claw docs โ platform tokens, CLI options, Docker, and YAML agent mode
7. Langflow Integration ๐ (Visual Flow Builder)
Build multi-agent workflows visually with drag-and-drop components in Langflow.
pip install "praisonai[flow]"
praisonai flow
Open http://localhost:7861 โ use the Agent and Agent Team components to create sequential or parallel workflows. Connect Chat Input โ Agent Team โ Chat Output for instant multi-agent pipelines.
๐ Full Flow docs โ visual agent building, component reference, and deployment
8. PraisonAI UI ๐ค (Clean Chat)
Lightweight chat interface for your AI agents.
pip install "praisonai[ui]"
praisonai ui
๐ Using YAML (No Code)
Example 1: Two Agents Working Together
Create agents.yaml:
framework: praisonai
topic: "Write a blog post about AI"
agents:
researcher:
role: Research Analyst
goal: Research AI trends and gather information
instructions: "Find accurate information about AI trends"
writer:
role: Content Writer
goal: Write engaging blog posts
instructions: "Write clear, engaging content based on research"
Run with:
praisonai agents.yaml
The agents automatically work together sequentially
Example 2: Agent with Custom Tool
Create two files in the same folder:
agents.yaml:
framework: praisonai
topic: "Calculate the sum of 25 and 15"
agents:
calculator_agent:
role: Calculator
goal: Perform calculations
instructions: "Use the add_numbers tool to help with calculations"
tools:
- add_numbers
tools.py:
def add_numbers(a: float, b: float) -> float:
"""
Add two numbers together.
Args:
a: First number
b: Second number
Returns:
The sum of a and b
"""
return a + b
Run with:
praisonai agents.yaml
๐ก Tips:
- Use the function name (e.g.,
add_numbers) in the tools list, not the file name- Tools in
tools.pyare automatically discovered- The function's docstring helps the AI understand how to use it
๐ฏ CLI Quick Reference
| Category | Commands |
|---|---|
| Execution | praisonai, --auto, --interactive, --chat |
| Research | research, --query-rewrite, --deep-research |
| Planning | --planning, --planning-tools, --planning-reasoning |
| Workflows | workflow run, workflow list, workflow auto |
| Memory | memory show, memory add, memory search, memory clear |
| Knowledge | knowledge add, knowledge query, knowledge list |
| Sessions | session list, session resume, session delete |
| Tools | tools list, tools info, tools search |
| MCP | mcp list, mcp create, mcp enable |
| Development | commit, docs, checkpoint, hooks |
| Scheduling | schedule start, schedule list, schedule stop |
๐ Full CLI reference
โจ Key Features
๐ค Core Agents
| Feature | Code | Docs |
|---|---|---|
| Single Agent | Example | ๐ |
| Multi Agents | Example | ๐ |
| Auto Agents | Example | ๐ |
| Self Reflection AI Agents | Example | ๐ |
| Reasoning AI Agents | Example | ๐ |
| Multi Modal AI Agents | Example | ๐ |
๐ Workflows
| Feature | Code | Docs |
|---|---|---|
| Simple Workflow | Example | ๐ |
| Workflow with Agents | Example | ๐ |
Agentic Routing (route()) |
Example | ๐ |
Parallel Execution (parallel()) |
Example | ๐ |
Loop over List/CSV (loop()) |
Example | ๐ |
Evaluator-Optimizer (repeat()) |
Example | ๐ |
| Conditional Steps | Example | ๐ |
| Workflow Branching | Example | ๐ |
| Workflow Early Stop | Example | ๐ |
| Workflow Checkpoints | Example | ๐ |
๐ป Code & Development
| Feature | Code | Docs |
|---|---|---|
| Code Interpreter Agents | Example | ๐ |
| AI Code Editing Tools | Example | ๐ |
| External Agents (All) | Example | ๐ |
| Claude Code CLI | Example | ๐ |
| Gemini CLI | Example | ๐ |
| Codex CLI | Example | ๐ |
| Cursor CLI | Example | ๐ |
๐ง Memory & Knowledge
| Feature | Code | Docs |
|---|---|---|
| Memory (Short & Long Term) | Example | ๐ |
| File-Based Memory | Example | ๐ |
| Claude Memory Tool | Example | ๐ |
| Add Custom Knowledge | Example | ๐ |
| RAG Agents | Example | ๐ |
| Chat with PDF Agents | Example | ๐ |
| Data Readers (PDF, DOCX, etc.) | CLI | ๐ |
| Vector Store Selection | CLI | ๐ |
| Retrieval Strategies | CLI | ๐ |
| Rerankers | CLI | ๐ |
| Index Types (Vector/Keyword/Hybrid) | CLI | ๐ |
| Query Engines (Sub-Question, etc.) | CLI | ๐ |
๐ฌ Research & Intelligence
| Feature | Code | Docs |
|---|---|---|
| Deep Research Agents | Example | ๐ |
| Query Rewriter Agent | Example | ๐ |
| Native Web Search | Example | ๐ |
| Built-in Search Tools | Example | ๐ |
| Unified Web Search | Example | ๐ |
| Web Fetch (Anthropic) | Example | ๐ |
๐ Planning & Execution
| Feature | Code | Docs |
|---|---|---|
| Planning Mode | Example | ๐ |
| Planning Tools | Example | ๐ |
| Planning Reasoning | Example | ๐ |
| Prompt Chaining | Example | ๐ |
| Evaluator Optimiser | Example | ๐ |
| Orchestrator Workers | Example | ๐ |
๐ฅ Specialized Agents
| Feature | Code | Docs |
|---|---|---|
| Data Analyst Agent | Example | ๐ |
| Finance Agent | Example | ๐ |
| Shopping Agent | Example | ๐ |
| Recommendation Agent | Example | ๐ |
| Wikipedia Agent | Example | ๐ |
| Programming Agent | Example | ๐ |
| Math Agents | Example | ๐ |
| Markdown Agent | Example | ๐ |
| Prompt Expander Agent | Example | ๐ |
๐จ Media & Multimodal
| Feature | Code | Docs |
|---|---|---|
| Image Generation Agent | Example | ๐ |
| Image to Text Agent | Example | ๐ |
| Video Agent | Example | ๐ |
| Camera Integration | Example | ๐ |
๐ Protocols & Integration
| Feature | Code | Docs |
|---|---|---|
| MCP Transports | Example | ๐ |
| WebSocket MCP | Example | ๐ |
| MCP Security | Example | ๐ |
| MCP Resumability | Example | ๐ |
| MCP Config Management | Docs | ๐ |
| LangChain Integrated Agents | Example | ๐ |
๐ก๏ธ Safety & Control
| Feature | Code | Docs |
|---|---|---|
| Guardrails | Example | ๐ |
| Human Approval | Example | ๐ |
| Rules & Instructions | Docs | ๐ |
โ๏ธ Advanced Features
| Feature | Code | Docs |
|---|---|---|
| Async & Parallel Processing | Example | ๐ |
| Parallelisation | Example | ๐ |
| Repetitive Agents | Example | ๐ |
| Agent Handoffs | Example | ๐ |
| Stateful Agents | Example | ๐ |
| Autonomous Workflow | Example | ๐ |
| Structured Output Agents | Example | ๐ |
| Model Router | Example | ๐ |
| Prompt Caching | Example | ๐ |
| Fast Context | Example | ๐ |
๐ ๏ธ Tools & Configuration
| Feature | Code | Docs |
|---|---|---|
| 100+ Custom Tools | Example | ๐ |
| YAML Configuration | Example | ๐ |
| 100+ LLM Support | Example | ๐ |
| Callback Agents | Example | ๐ |
| Hooks | Example | ๐ |
| Middleware System | Example | ๐ |
| Configurable Model | Example | ๐ |
| Rate Limiter | Example | ๐ |
| Injected Tool State | Example | ๐ |
| Shadow Git Checkpoints | Example | ๐ |
| Background Tasks | Example | ๐ |
| Policy Engine | Example | ๐ |
| Thinking Budgets | Example | ๐ |
| Output Styles | Example | ๐ |
| Context Compaction | Example | ๐ |
๐ Monitoring & Management
| Feature | Code | Docs |
|---|---|---|
| Sessions Management | Example | ๐ |
| Auto-Save Sessions | Docs | ๐ |
| History in Context | Docs | ๐ |
| Telemetry | Example | ๐ |
| Project Docs (.praison/docs/) | Docs | ๐ |
| AI Commit Messages | Docs | ๐ |
| @Mentions in Prompts | Docs | ๐ |
๐ฅ๏ธ CLI Features
| Feature | Code | Docs |
|---|---|---|
| Slash Commands | Example | ๐ |
| Autonomy Modes | Example | ๐ |
| Cost Tracking | Example | ๐ |
| Repository Map | Example | ๐ |
| Interactive TUI | Example | ๐ |
| Git Integration | Example | ๐ |
| Sandbox Execution | Example | ๐ |
| CLI Compare | Example | ๐ |
| Profile/Benchmark | Docs | ๐ |
| Auto Mode | Docs | ๐ |
| Init | Docs | ๐ |
| File Input | Docs | ๐ |
| Final Agent | Docs | ๐ |
| Max Tokens | Docs | ๐ |
๐งช Evaluation
| Feature | Code | Docs |
|---|---|---|
| Accuracy Evaluation | Example | ๐ |
| Performance Evaluation | Example | ๐ |
| Reliability Evaluation | Example | ๐ |
| Criteria Evaluation | Example | ๐ |
๐ป Using JavaScript Code
npm install praisonai
export OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxx
const { Agent } = require('praisonai');
const agent = new Agent({ instructions: 'You are a helpful AI assistant' });
agent.start('Write a movie script about a robot in Mars');
โญ Star History
๐ Video Tutorials
Learn PraisonAI through our comprehensive video series:
View all 22 video tutorials
๐ฅ Contributing
We welcome contributions! Fork the repo, create a branch, and submit a PR โ Contributing Guide.
โ FAQ & Troubleshooting
ModuleNotFoundError: No module named 'praisonaiagents'
Install the package:
pip install praisonaiagents
API key not found / Authentication error
Ensure your API key is set:
export OPENAI_API_KEY=your_key_here
For other providers, see Models docs.
How do I use a local model (Ollama)?
# Start Ollama server first
ollama serve
# Set environment variable
export OPENAI_BASE_URL=http://localhost:11434/v1
See Models docs for more details.
How do I persist conversations to a database?
Use the db parameter:
from praisonaiagents import Agent, db
agent = Agent(
name="Assistant",
db=db(database_url="postgresql://localhost/mydb"),
session_id="my-session"
)
See Persistence docs for supported databases.
How do I enable agent memory?
from praisonaiagents import Agent
agent = Agent(
name="Assistant",
memory=True, # Enables file-based memory (no extra deps!)
user_id="user123"
)
See Memory docs for more options.
How do I run multiple agents together?
from praisonaiagents import Agent, Agents
agent1 = Agent(instructions="Research topics")
agent2 = Agent(instructions="Summarize findings")
agents = Agents(agents=[agent1, agent2])
agents.start()
See Agents docs for more examples.
How do I use MCP tools?
from praisonaiagents import Agent, MCP
agent = Agent(
tools=MCP("npx @modelcontextprotocol/server-memory")
)
See MCP docs for all transport options.
Getting Help
- ๐ Full Documentation
- ๐ Report Issues
- ๐ฌ Discussions
Made with โค๏ธ by the PraisonAI Team
๐ Documentation โข GitHub โข โถ๏ธ YouTube โข ๐ X โข ๐ผ LinkedIn
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file praisonaiagents-1.5.112.tar.gz.
File metadata
- Download URL: praisonaiagents-1.5.112.tar.gz
- Upload date:
- Size: 1.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.22
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e33df8d095ad21a37389944b481f2b3d52635f3fe7159c8f0989d153d7093608
|
|
| MD5 |
018fceb06928f5ea1a61d28580acdd0a
|
|
| BLAKE2b-256 |
ee58dd1d42105cc9dd8506ee6bc3ac47e74afd070bbabeaa7057483dc05e9cb7
|
File details
Details for the file praisonaiagents-1.5.112-py3-none-any.whl.
File metadata
- Download URL: praisonaiagents-1.5.112-py3-none-any.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.22
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa1a3d4239ad6d756e4fe4f44273a5f6fd8f098c7ede4b57c0ca3e27838801fd
|
|
| MD5 |
dba363416b6020a056d8bed602d34f7b
|
|
| BLAKE2b-256 |
b54dc32f3980fdbb31d8a2a36396d57ff3dab02fcb9f20c3bd70bfa3f8dbae9f
|