overai 1.4.2 → 1.4.3

package/README.md

@@ -1,257 +1,116 @@
 # OverAI TypeScript Node.js AI Agents Framework
 
-OverAI is a production-ready Multi AI Agents framework, designed to create AI Agents to automate and solve problems ranging from simple tasks to complex challenges. It provides a low-code solution to streamline the building and management of multi-agent LLM systems, emphasising simplicity, customisation, and effective human-agent collaboration.
+[![npm version](https://img.shields.io/npm/v/overai.svg)](https://www.npmjs.com/package/overai)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/MervinPraison/PraisonAI/ci.yml?branch=main)](https://github.com/MervinPraison/PraisonAI/actions)
+[![Downloads](https://img.shields.io/npm/dm/overai.svg)](https://www.npmjs.com/package/overai)
 
-## Why OverAI? (vs n8n and others)
+**OverAI** is the production-ready Multi AI Agents framework that lets you **Build, Deploy, and Monetize** AI agents. From simple automation scripts to full-fledged AI SaaS platforms with billing and API keys, OverAI handles the complexity so you can focus on the business logic.
 
-While visual workflow tools like **n8n** are excellent for linear automation, **OverAI** is designed for the next generation of intelligent orchestration:
+## 🚀 Why OverAI?
 
-- **Code-First Autonomy**: Move beyond rigid flowcharts. Define complex, dynamic agent behaviors using standard TypeScript/JavaScript that can adapt to changing contexts.
-- **True Multi-Agent Collaboration**: Agents don't just pass data; they communicate, delegate tasks, critique each other's work, and solve problems iteratively.
-- **Production-Grade Engineering**: Built for developers. Benefit from Git version control, TypeScript type safety, CI/CD integration, and easy debugging—things that are hard to do with visual drag-and-drop tools.
-- **Deep Embedding**: Don't just call an external webhook. Embed powerful AI agents directly into your existing backend services and APIs.
+Stop stitching together disparate tools. OverAI provides a unified "Business-in-a-Box" framework for AI developers:
 
-## Installation
+- **💰 Built-in Monetization**: Includes ready-to-use SaaS templates with **Stripe integration** and **Credit Systems**.
+- **🔌 Enterprise Integrations**: Native support for **N8N workflows**, **MCP Servers**, and **Slack**.
+- **🧠 Code-First Autonomy**: Define complex, dynamic agent behaviors using standard TypeScript/JavaScript.
+- **🤝 True Multi-Agent Collaboration**: Agents that communicate, delegate, and solve problems together.
+- **🛡️ Production-Grade**: Type-safe, CI/CD friendly, and scalable.
 
-```bash
-npm install overai
-```
+---
 
-## Development Setup
-
-1. Clone the repository:
-```bash
-git clone https://github.com/your-username/overai.git
-cd overai
-```
+## 📦 Installation
 
-2. Install dependencies:
 ```bash
-npm install
-```
-
-3. Build the package:
-```bash
-npm run build
+npm install overai
 ```
 
-## Usage
-
-Here are examples of different ways to use OverAI:
-
-### 1. Single Agent Example
+## ⚡ Quick Start: Your First Agent
 
 ```typescript
 import { Agent, OverAI } from 'overai';
 
 async function main() {
-    // Create a simple agent (no task specified)
     const agent = new Agent({
-        name: "BiologyExpert",
-        instructions: "Explain the process of photosynthesis in detail.",
+        name: "Helper",
+        instructions: "You are a helpful assistant.",
         verbose: true
     });
 
-    // Run the agent
     const overAI = new OverAI({
         agents: [agent],
-        tasks: ["Explain the process of photosynthesis in detail."],
+        tasks: ["Say hello and introduce yourself."],
         verbose: true
     });
 
-    try {
-        console.log('Starting single agent example...');
-        const results = await overAI.start();
-        console.log('\nFinal Results:', results);
-    } catch (error) {
-        console.error('Error:', error);
-    }
+    await overAI.start();
 }
-
 main();
 ```
 
-### 2. Multi-Agent Example
+---
 
-```typescript
-import { Agent, OverAI } from 'overai';
-
-async function main() {
-    // Create multiple agents with different roles
-    const researchAgent = new Agent({
-        name: "ResearchAgent",
-        instructions: "Research and provide detailed information about renewable energy sources.",
-        verbose: true
-    });
-
-    const summaryAgent = new Agent({
-        name: "SummaryAgent",
-        instructions: "Create a concise summary of the research findings about renewable energy sources. Use {previous_result} as input.",
-        verbose: true
-    });
-
-    const recommendationAgent = new Agent({
-        name: "RecommendationAgent",
-        instructions: "Based on the summary in {previous_result}, provide specific recommendations for implementing renewable energy solutions.",
-        verbose: true
-    });
+## 💸 Build Your AI SaaS in 5 Minutes
 
-    // Run the agents in sequence
-    const overAI = new OverAI({
-        agents: [researchAgent, summaryAgent, recommendationAgent],
-        tasks: [
-            "Research and analyze current renewable energy technologies and their implementation.",
-            "Summarize the key findings from the research.",
-            "Provide actionable recommendations based on the summary."
-        ],
-        verbose: true
-    });
+OverAI includes a complete SaaS starter kit. Launch an API server with:
+- ✅ **API Key Authentication**
+- ✅ **Credit-Based Billing** (Pay-per-request)
+- ✅ **Stripe Payment Simulation**
+- ✅ **N8N Webhook Integration**
 
-    try {
-        console.log('Starting multi-agent example...');
-        const results = await overAI.start();
-        console.log('\nFinal Results:', results);
-    } catch (error) {
-        console.error('Error:', error);
-    }
-}
+### Run the SaaS Server Example
+```bash
+# Set your OpenAI Key
+export OPENAI_API_KEY="sk-..."
 
-main();
+# Run the pre-built SaaS server
+npx ts-node examples/saas-server.ts
 ```
 
-### 3. Task-Based Agent Example
-
-```typescript
-import { Agent, Task, OverAI } from 'overai';
+Your API is now live at `http://localhost:3001`!
 
-async function main() {
-    // Create agents first
-    const dietAgent = new Agent({
-        name: "DietAgent",
-        role: "Nutrition Expert",
-        goal: "Create healthy and delicious recipes",
-        backstory: "You are a certified nutritionist with years of experience in creating balanced meal plans.",
-        verbose: true,  // Enable streaming output
-        instructions: `You are a professional chef and nutritionist. Create 5 healthy food recipes that are both nutritious and delicious.
-Each recipe should include:
-1. Recipe name
-2. List of ingredients with quantities
-3. Step-by-step cooking instructions
-4. Nutritional information
-5. Health benefits
-
-Format your response in markdown.`
-    });
-
-    const blogAgent = new Agent({
-        name: "BlogAgent",
-        role: "Food Blogger",
-        goal: "Write engaging blog posts about food and recipes",
-        backstory: "You are a successful food blogger known for your ability to make recipes sound delicious and approachable.",
-        verbose: true,  // Enable streaming output
-        instructions: `You are a food and health blogger. Write an engaging blog post about the provided recipes.
-The blog post should:
-1. Have an engaging title
-2. Include an introduction about healthy eating`
-    });
+### Monetization Endpoints
+- **Chat**: `POST /api/v1/agent/chat` (Costs 1 credit)
+- **Top-up**: `POST /api/billing/topup` (Simulate Stripe payment)
 
-    // Create tasks
-    const createRecipesTask = new Task({
-        name: "Create Recipes",
-        description: "Create 5 healthy and delicious recipes",
-        agent: dietAgent
-    });
+[View the full SaaS Server Code](./examples/saas-server.ts)
 
-    const writeBlogTask = new Task({
-        name: "Write Blog",
-        description: "Write a blog post about the recipes",
-        agent: blogAgent,
-        dependencies: [createRecipesTask]  // This task depends on the recipes being created first
-    });
+---
 
-    // Run the tasks
-    const overAI = new OverAI({
-        tasks: [createRecipesTask, writeBlogTask],
-        verbose: true
-    });
+## 🔗 Integrations
 
-    try {
-        console.log('Starting task-based example...');
-        const results = await overAI.start();
-        console.log('\nFinal Results:', results);
-    } catch (error) {
-        console.error('Error:', error);
-    }
-}
-
-main();
+### N8N & Workflow Automation
+Expose your agents as N8N nodes or trigger workflows directly from your agents.
+```typescript
+// Built-in webhook support for external triggers
+app.post('/api/webhook/n8n', async (req, res) => {
+    // Trigger agent workflows from N8N
+});
 ```
 
-### Running the Examples
+### Model Context Protocol (MCP)
+Connect your agents to external data sources and tools using the standardized MCP protocol.
 
-1. First, set up your environment variables:
-```bash
-export OPENAI_API_KEY='your-api-key'
-```
+---
 
-2. Create a new TypeScript file (e.g., `example.ts`) with any of the above examples.
+## 🛠️ Development Setup
 
-3. Run the example:
+1. Clone the repository:
 ```bash
-npx ts-node example.ts
+git clone https://github.com/MervinPraison/PraisonAI.git
+cd PraisonAI/src/praisonai-ts
 ```
 
-For more examples, check out the `examples/concepts/` directory in the repository.
-
-## Package Structure
-
-```
-src/
-├── agent/         # Agent-related interfaces and implementations
-├── agents/        # Multi-agent system management
-├── knowledge/     # Knowledge base and management
-├── llm/          # Language Model interfaces
-├── memory/       # Memory management systems
-├── process/      # Process management
-├── task/         # Task management
-└── tools/        # Various utility tools
-    ├── arxivTools.ts
-    └── ... (other tools)
-```
-
-## Contributing
-
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add some amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
-
-## License
-
-MIT License - see the LICENSE file for details
-
-## Testing
-
-### Manual Testing
-
+2. Install dependencies:
 ```bash
-export OPENAI_API_KEY='your-api-key'
-npx ts-node tests/development/simple/single-agent.ts
-npx ts-node tests/development/simple/multi-agent.ts
-npx ts-node tests/development/simple/multi-agents-simple.js
+npm install
 ```
 
-## Examples Testing
-
+3. Build the package:
 ```bash
-export OPENAI_API_KEY='your-api-key'
-npx ts-node examples/simple/single-agent.ts
-npx ts-node examples/simple/multi-agent.ts
+npm run build
 ```
 
-### Automated Testing (WIP)
+## License
 
-```bash
-npm run test
-```
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "overai",
-  "version": "1.4.2",
-  "description": "OverAI TypeScript AI Agents Framework - Production-ready Multi-Agent System",
+  "version": "1.4.3",
+  "description": "OverAI TypeScript AI Agents Framework - Build, Deploy, and Monetize AI Agents in Minutes",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -46,7 +46,11 @@
     "javascript ai framework",
     "ai agent framework",
     "typescript ai agent framework",
-    "javascript ai agent framework"
+    "javascript ai agent framework",
+    "ai saas",
+    "ai monetization",
+    "ai billing",
+    "ai api server"
   ],
   "author": "Mervin Praison",
   "license": "MIT",