[docs][swarms-platform]

docs/mkdocs.yml

@@ -279,7 +279,9 @@ nav:
       - Faiss: "swarms_memory/faiss.md"
   - Swarms Marketplace:
     - Overview: "swarms_platform/index.md"
-    - Share & Discover Prompts, Agents, Tools, and more: "swarms_platform/share_discover.md"
+    - Agent Marketplace: "swarms_platform/share_discover.md"
+    - Swarm Platform API Keys: "swarms_platform/apikeys.md"
+    - Account Management: "swarms_platform/account_management.md"
     - Prompts API: 
       - Add Prompts: "swarms_platform/prompts/add_prompt.md"
       - Edit Prompts: "swarms_platform/prompts/edit_prompt.md"

docs/swarms_platform/account_management.md

@@ -0,0 +1,189 @@
+# Swarms Platform Account Management Documentation
+
+This guide provides comprehensive, production-grade documentation for managing your account on the Swarms Platform. It covers account settings, profile management, billing, payment methods, subscription details, and cryptocurrency wallet management. Use this documentation to navigate the account management interface, understand available options, and perform account-related operations efficiently and securely.
+
+---
+
+## Table of Contents
+
+1. [Overview](#overview)
+2. [Accessing the Account Management Page](#accessing-the-account-management-page)
+3. [Account Settings](#account-settings)
+   - [Theme Mode](#theme-mode)
+4. [Profile Management](#profile-management)
+   - [Profile Information](#profile-information)
+   - [Password Management](#password-management)
+5. [Billing and Payment Methods](#billing-and-payment-methods)
+   - [Subscription Status](#subscription-status)
+   - [Payment Methods](#payment-methods)
+6. [Cryptocurrency Wallet](#cryptocurrency-wallet)
+   - [Wallet Overview](#wallet-overview)
+   - [Exchange and Transaction History](#exchange-and-transaction-history)
+7. [Additional Resources](#additional-resources)
+
+---
+
+## Overview
+
+The Swarms Platform account management page, available at [https://swarms.world/platform/account](https://swarms.world/platform/account), allows you to configure and update your account settings and preferences. From here, you can manage the appearance of the platform, view and update profile details, manage your billing information and subscriptions, and handle your cryptocurrency wallet operations.
+
+---
+
+## Accessing the Account Management Page
+
+To access your account management dashboard:
+1. Log in to your Swarms Platform account.
+2. Navigate to [https://swarms.world/platform/account](https://swarms.world/platform/account).
+
+Once on this page, you will see several sections dedicated to different aspects of your account:
+
+- **Account Settings:** Customize the platform appearance and user interface.
+- **Profile:** View and manage personal details.
+- **Billing:** Review credits, invoices, and manage your payment methods.
+- **Crypto:** Manage your cryptocurrency wallet and transactions.
+
+---
+
+## Account Settings
+
+This section allows you to modify your personal account preferences, including the visual theme.
+
+### Theme Mode
+
+You can choose between different theme options to tailor your user experience:
+
+- **Single Theme:**  
+  A fixed theme, independent of system settings.
+  - **Example:**  
+    - **Logo:** Swarms logo
+    - **Terminal Command:**  
+      ```bash
+      pip3 install -U swarms
+      ```
+    - **Theme Options:**  
+      - **light**  
+      - **dark (default)**
+
+- **Sync with System Theme:**  
+  Automatically adjusts the platform theme to match your system's theme settings.
+
+Select the theme mode that best fits your workflow. Changes are applied immediately across the platform.
+
+---
+
+## Profile Management
+
+### Profile Information
+
+The Profile section allows you to view and update your personal details:
+
+- **View Details:**  
+  Your current profile information is displayed, including contact details, username, and any additional settings.
+  
+- **Manage Profile:**  
+  Options to update your information, ensuring your account details remain current.
+
+### Password Management
+
+For security purposes, it is important to regularly update your password:
+
+- **Change Password:**  
+  Select the **"Change password"** option to update your login credentials.  
+  Ensure you choose a strong password and keep it confidential.
+
+---
+
+## Billing and Payment Methods
+
+The Billing section helps you manage financial aspects of your account, including credits, invoices, and subscriptions.
+
+### Subscription Status
+
+Your subscription details are clearly displayed:
+
+- **Current Plan:**  
+  Options include **Free**, **Premium**, or **Enterprise**.
+  
+- **Status:**  
+  The active subscription status is indicated (e.g., "Active").
+  
+- **Customer Portal:**  
+  An option to open the customer portal for additional billing and subscription management.
+
+### Payment Methods
+
+Manage your payment methods and review your billing details:
+
+- **Manage Cards:**  
+  View existing payment methods.  
+  **Example Entry:**
+  - **Card Type:** mastercard
+  - **Last 4 Digits:** ending in 9491
+  - **Expiry Date:** 2030/2
+  
+- **Add Card:**  
+  Use the **"Add Card"** option to register a new payment method securely.
+
+### Credit System
+
+Details of the credits available for your account:
+
+- **Credits Available:**  
+  Displays the current credit balance (e.g., `$20.00`).
+  
+- **Charge:**  
+  Option to apply charges against your available credits.
+  
+- **Invoice:**  
+  Review or download your invoices.
+
+---
+
+## Cryptocurrency Wallet
+
+The Crypto section provides management tools for your cryptocurrency wallet and associated transactions.
+
+### Wallet Overview
+
+- **Connected Wallet:**  
+  Displays your linked wallet information.
+  - **Example:**  
+    - **Wallet Identifier:** A truncated wallet ID (e.g., `EmVa...79Vb`)
+  
+- **$swarms Balance and Price:**
+  - **Balance:**  
+    Displays your current $swarms balance (e.g., `0.00`).
+  - **Price:**  
+    Current market price for $swarms (e.g., `$0.0400`).
+
+### Exchange and Transaction History
+
+- **Exchange Functionality:**  
+  Option to exchange $swarms tokens for credits directly through the platform.
+  
+- **Transaction History:**  
+  View a detailed log of wallet transactions, ensuring full transparency over all exchanges and wallet activity.
+
+---
+
+## Additional Resources
+
+For further assistance or to learn more about managing your account on the Swarms Platform, refer to the following resources:
+
+- [Help Center](https://swarms.world/help)
+- [Customer Support](https://cal.com/swarms)
+- [API Documentation](https://swarms.world/platform/api-keys) (for developers)
+
+---
+
+## Best Practices
+
+- **Regular Updates:**  
+  Periodically review your account settings, profile, and payment methods to ensure they are up-to-date.
+  
+- **Security Measures:**  
+  Always use strong, unique passwords and consider enabling two-factor authentication if available.
+  
+- **Monitor Transactions:**  
+  Regularly check your billing and wallet transaction history to detect any unauthorized activities promptly.
+

docs/swarms_platform/apikeys.md

@@ -0,0 +1,87 @@
+# Swarms Platform API Keys Documentation
+
+This document provides detailed information on managing API keys within the Swarms Platform. API keys grant programmatic access to your account and should be handled securely. Follow the guidelines below to manage your API keys safely and effectively.
+
+---
+
+## Table of Contents
+
+1. [Overview](#overview)
+2. [Viewing Your API Keys](#viewing-your-api-keys)
+3. [Creating a New API Key](#creating-a-new-api-key)
+4. [Security Guidelines](#security-guidelines)
+5. [Frequently Asked Questions](#frequently-asked-questions)
+
+---
+
+## Overview
+
+API keys are unique credentials that allow you to interact with the Swarms Platform programmatically. These keys enable you to make authenticated API requests to access or modify your data. **Important:** Once a secret API key is generated, it will not be displayed again. Ensure you store it securely, as it cannot be retrieved from the platform later.
+
+---
+
+## Viewing Your API Keys
+
+When you navigate to the API Keys page ([https://swarms.world/platform/api-keys](https://swarms.world/platform/api-keys)), you will see a list of your API keys along with the following information:
+
+### Key Details:
+
+- **Name:** A label you assign to your API key to help you identify it.
+- **Key:** The secret API key is only partially visible here for security reasons.
+- **Created Date:** The date when the API key was generated.
+- **Actions:** Options available for managing the key (e.g., deleting an API key).
+
+---
+
+## Creating a New API Key
+
+To generate a new API key, follow these steps:
+
+1. **Attach a Credit Card:**  
+   Before creating a new API key, ensure that your account has a credit card attached. This is required for authentication and billing purposes.
+
+2. **Access the API Keys Page:**  
+   Navigate to [https://swarms.world/platform/api-keys](https://swarms.world/platform/api-keys).
+
+3. **Generate a New Key:**  
+   Click on the **"Create new API key"** button. The system will generate a new secret API key for your account.
+
+4. **Store Your API Key Securely:**  
+   Once generated, the full API key will be displayed only once. Copy and store it in a secure location, as it will not be displayed again.  
+   **Note:** Do not share your API key with anyone or expose it in any client-side code (e.g., browser JavaScript).
+
+---
+
+## Security Guidelines
+
+- **Confidentiality:**  
+  Your API keys are sensitive credentials. Do not share them with anyone or include them in public repositories or client-side code.
+
+- **Storage:**  
+  Store your API keys in secure, encrypted storage. Avoid saving them in plain text files or unsecured locations.
+
+- **Rotation:**  
+  If you suspect that your API key has been compromised, immediately delete it and create a new one.
+
+- **Access Control:**  
+  Limit access to your API keys to only those systems and personnel who absolutely require it.
+
+---
+
+## Frequently Asked Questions
+
+### Q1: **Why do I need a credit card attached to my account to create an API key?**  
+**A:** The requirement to attach a credit card helps verify your identity and manage billing, ensuring responsible usage of the API services provided by the Swarms Platform.
+
+### Q2: **What happens if I lose my API key?**  
+**A:** If you lose your API key, you will need to generate a new one. The platform does not store the full key after its initial generation, so recovery is not possible.
+
+### Q3: **How can I delete an API key?**  
+**A:** On the API Keys page, locate the key you wish to delete and click the **"Delete"** action next to it. This will revoke the key's access immediately.
+
+### Q4: **Can I have multiple API keys?**  
+**A:** Yes, you can generate and manage multiple API keys. Use naming conventions to keep track of their usage and purpose.
+
+---
+
+For any further questions or issues regarding API key management, please refer to our [Help Center](https://swarms.world/help) or contact our support team.

examples/hs_examples/hierarchical_swarm_example.py → hierarchical_swarm_example.py

@@ -93,14 +93,13 @@ def main():
     # - max_loops: Maximum number of feedback loops between director & agents
     # --------------------------------------------------------------------------
     swarm = HierarchicalSwarm(
-        name="HierarchicalAgentSwarm",
         description=(
             "A specialized swarm in which the Director delegates tasks to a Stock "
             "Analysis Agent for thorough market evaluation."
         ),
         director=llm,
         agents=[analysis_agent],
-        max_loops=2,  # Limit on feedback iterations
+        max_loops=1,  # Limit on feedback iterations
     )
 
     # --------------------------------------------------------------------------
@@ -123,7 +122,7 @@ def main():
     )
 
     # Run the swarm with the user_request
-    print(swarm.run(user_request))
+    swarm.run(user_request)
 
 
 if __name__ == "__main__":

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "swarms"
-version = "7.0.4"
+version = "7.0.9"
 description = "Swarms - TGSC"
 license = "MIT"
 authors = ["Kye Gomez <[email protected]>"]

swarms/structs/__init__.py

@@ -26,7 +26,11 @@
     most_frequent,
     parse_code_completion,
 )
+from swarms.structs.meme_agent_persona_generator import (
+    MemeAgentGenerator,
+)
 from swarms.structs.mixture_of_agents import MixtureOfAgents
+from swarms.structs.model_router import ModelRouter
 from swarms.structs.multi_agent_collab import MultiAgentCollaboration
 from swarms.structs.multi_agent_exec import (
     run_agent_with_timeout,
@@ -81,10 +85,6 @@
     find_token_in_text,
     parse_tasks,
 )
-from swarms.structs.meme_agent_persona_generator import (
-    MemeAgentGenerator,
-)
-from swarms.structs.model_router import ModelRouter
 
 __all__ = [
     "Agent",