diff --git a/docs/swarms_cloud/api_pricing.md b/docs/swarms_cloud/api_pricing.md index 1ba70e00..ce7278ab 100644 --- a/docs/swarms_cloud/api_pricing.md +++ b/docs/swarms_cloud/api_pricing.md @@ -1,31 +1,25 @@ -# Swarm Agent API Pricing Documentation +# Swarm Agent API Pricing +!!! success "🎉 Get Started with $20 Free Credits!" + New users receive $20 in free credits when they sign up! [Create your account now](https://swarms.world/platform/account) to start building with our powerful multi-agent platform. -The Swarm Agent API provides a powerful platform for managing multi-agent collaboration at scale and orchestrating swarms of LLM agents in the cloud. This document outlines the pricing model, how costs are calculated, and how to purchase and manage your credits. - -Our pricing is designed to be transparent and cost-effective, enabling you to harness the full potential of your agents with ease. Costs are based on: - -- Number of agents used - -- Input and output token usage - -- Execution time +!!! abstract "Overview" + The Swarm Agent API provides a powerful platform for managing multi-agent collaboration at scale and orchestrating swarms of LLM agents in the cloud. Our pricing model is designed to be transparent and cost-effective, enabling you to harness the full potential of your agents with ease. ## Credit System -The Swarm API operates on a credit-based system: +The Swarm API operates on a credit-based system with the following characteristics: - **Credits** are the currency used within the platform - - 1 credit = $1 USD - - Credits can be purchased with USD or $swarms Solana tokens -- Two types of credits: - - - **Standard Credits**: Purchased credits that never expire +### Credit Types - - **Free Credits**: Promotional credits that may have usage restrictions +| Type | Description | Expiration | +|------|-------------|------------| +| Standard Credits | Purchased credits | Never expires | +| Free Credits | Promotional credits | May have expiration dates | ## Pricing Structure @@ -44,11 +38,12 @@ The Swarm API operates on a credit-based system: ### Night-Time Discount -To encourage efficient resource usage during off-peak hours, we offer significant discounts for operations performed during California night-time hours: +!!! tip "Off-Peak Hours Discount" + To encourage efficient resource usage during off-peak hours, we offer significant discounts for operations performed during California night-time hours: -| Time Period (Pacific Time) | Discount | -|----------------------------|----------| -| 8:00 PM to 6:00 AM | 75% off token costs | + | Time Period (Pacific Time) | Discount | + |----------------------------|----------| + | 8:00 PM to 6:00 AM | 75% off token costs | ## Cost Calculation @@ -56,14 +51,14 @@ To encourage efficient resource usage during off-peak hours, we offer significan The total cost for a swarm execution is calculated as follows: -``` +```math Total Cost = (Number of Agents × $0.01) + (Total Input Tokens / 1M × $2.00 × Number of Agents) + (Total Output Tokens / 1M × $4.50 × Number of Agents) ``` With night-time discount applied: -``` +```math Input Token Cost = Input Token Cost × 0.25 Output Token Cost = Output Token Cost × 0.25 ``` @@ -72,121 +67,100 @@ Output Token Cost = Output Token Cost × 0.25 #### Scenario 1: Basic Workflow (Day-time) -- 3 agents +!!! example "Basic Workflow Example" + **Parameters:** + - 3 agents + - 10,000 input tokens total + - 25,000 output tokens total -- 10,000 input tokens total - -- 25,000 output tokens total - -**Calculation:** - -- Agent cost: 3 × $0.01 = $0.03 - -- Input token cost: (10,000 / 1,000,000) × $2.00 × 3 = $0.06 - -- Output token cost: (25,000 / 1,000,000) × $4.50 × 3 = $0.3375 - -- **Total cost: $0.4275** + **Calculation:** + - Agent cost: 3 × $0.01 = $0.03 + - Input token cost: (10,000 / 1,000,000) × $2.00 × 3 = $0.06 + - Output token cost: (25,000 / 1,000,000) × $4.50 × 3 = $0.3375 + - **Total cost: $0.4275** #### Scenario 2: Complex Workflow (Night-time) -- 5 agents - -- 50,000 input tokens total - -- 125,000 output tokens total - -**Calculation:** +!!! example "Complex Workflow Example" + **Parameters:** + - 5 agents + - 50,000 input tokens total + - 125,000 output tokens total -- Agent cost: 5 × $0.01 = $0.05 - -- Input token cost: (50,000 / 1,000,000) × $2.00 × 5 × 0.25 = $0.125 - -- Output token cost: (125,000 / 1,000,000) × $4.50 × 5 × 0.25 = $0.703125 - -- **Total cost: $0.878125** + **Calculation:** + - Agent cost: 5 × $0.01 = $0.05 + - Input token cost: (50,000 / 1,000,000) × $2.00 × 5 × 0.25 = $0.125 + - Output token cost: (125,000 / 1,000,000) × $4.50 × 5 × 0.25 = $0.703125 + - **Total cost: $0.878125** ## Purchasing Credits Credits can be purchased through our platform in two ways: -1. **USD Payment** - - Available through our [account page](https://swarms.world/platform/account) - - Secure payment processing - - Minimum purchase: $10 +### USD Payment +- Available through our [account page](https://swarms.world/platform/account) +- Secure payment processing +- Minimum purchase: $10 -2. **$swarms Token Payment** - - Use Solana-based $swarms tokens - - Tokens can be purchased on supported exchanges - - Connect your Solana wallet on our [account page](https://swarms.world/platform/account) +### $swarms Token Payment +- Use Solana-based $swarms tokens +- Tokens can be purchased on supported exchanges +- Connect your Solana wallet on our [account page](https://swarms.world/platform/account) ## Free Credits -We occasionally offer free credits to: - -- New users (welcome bonus) - -- During promotional periods - -- For educational and research purposes - -Notes about free credits: - -- Used before standard credits - -- May have expiration dates +!!! info "Free Credit Program" + We occasionally offer free credits to: + - New users (welcome bonus) + - During promotional periods + - For educational and research purposes -- May have usage restrictions + **Important Notes:** + - Used before standard credits + - May have expiration dates + - May have usage restrictions ## Billing and Usage Tracking Track your credit usage through our comprehensive logging and reporting features: -1. **API Logs** +### API Logs +- Access detailed logs via the `/v1/swarm/logs` endpoint +- View cost breakdowns for each execution - - Access detailed logs via the `/v1/swarm/logs` endpoint - - - View cost breakdowns for each execution - -2. **Dashboard** - - - Real-time credit balance display - - - Historical usage graphs - - - Detailed cost analysis - - - Available at [https://swarms.world/platform/dashboard](https://swarms.world/platform/dashboard) +### Dashboard +- Real-time credit balance display +- Historical usage graphs +- Detailed cost analysis +- Available at [https://swarms.world/platform/dashboard](https://swarms.world/platform/dashboard) ## FAQ -**Q: Is there a minimum credit purchase?** -A: Yes, the minimum credit purchase is $10 USD equivalent. +??? question "Is there a minimum credit purchase?" + Yes, the minimum credit purchase is $10 USD equivalent. -**Q: Do credits expire?** -A: Standard credits do not expire. Free promotional credits may have expiration dates. +??? question "Do credits expire?" + Standard credits do not expire. Free promotional credits may have expiration dates. -**Q: How is the night-time discount applied?** -A: The system automatically detects the execution time based on Pacific Time (America/Los_Angeles) and applies a 75% discount to token costs for executions between 8:00 PM and 6:00 AM. +??? question "How is the night-time discount applied?" + The system automatically detects the execution time based on Pacific Time (America/Los_Angeles) and applies a 75% discount to token costs for executions between 8:00 PM and 6:00 AM. -**Q: What happens if I run out of credits during execution?** -A: Executions will fail with a 402 Payment Required error if sufficient credits are not available. We recommend maintaining a credit balance appropriate for your usage patterns. +??? question "What happens if I run out of credits during execution?" + Executions will fail with a 402 Payment Required error if sufficient credits are not available. We recommend maintaining a credit balance appropriate for your usage patterns. -**Q: Can I get a refund for unused credits?** -A: Please contact our support team for refund requests for unused credits. +??? question "Can I get a refund for unused credits?" + Please contact our support team for refund requests for unused credits. -**Q: Are there volume discounts available?** -A: Yes, please contact our sales team for enterprise pricing and volume discounts. +??? question "Are there volume discounts available?" + Yes, please contact our sales team for enterprise pricing and volume discounts. ## References - [Swarm API Documentation](https://docs.swarms.world/en/latest/swarms_cloud/swarms_api/) - - [Account Management Portal](https://swarms.world/platform/account) - - [Swarm Types Reference](https://docs.swarms.world/swarms_cloud/swarm_types) - --- -For additional questions or custom pricing options, please contact our support team at kye@swarms.world. \ No newline at end of file +!!! info "Need Help?" + For additional questions or custom pricing options, please contact our support team at [kye@swarms.world](mailto:kye@swarms.world). \ No newline at end of file