Swarms API Documentation

The hosted documentation for the Swarms API, built with Mintlify.

🚀 Quick Start

Prerequisites

• Node.js (version 16 or higher)
• npm or yarn

Installation

1. Install Mintlify CLI globally:

   npm install -g @mintlify/cli

2. Clone this repository:

   git clone https://github.com/The-Swarm-Corporation/swarms-api-docs.git
   cd swarms-api-docs

Development

1. Start the development server:

   mint dev

2. Open your browser and navigate to:

   http://localhost:3000
   

The documentation will automatically reload when you make changes to the files.

Building for Production

To build the documentation for production:

mint build

Deployment

To deploy to Mintlify's hosting service:

mint deploy

📁 Project Structure

swarms-api-docs/
├── api-reference/          # API endpoint documentation
├── getting-started/        # Getting started guides
├── resources/              # Additional resources
├── logo/                   # Brand assets
├── mint.json              # Mintlify configuration
└── README.md              # This file

🔧 Configuration

The mint.json file contains the configuration for:

• Theme and branding
• Navigation structure
• OpenAPI specification source
• Social media links
• Custom styling

📚 Documentation Sections

• Getting Started: Quick start guide, API key setup, and architecture overview
• API Reference: Complete API endpoint documentation with examples
• Resources: Client libraries, pricing, and community resources

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test with mint dev
5. Submit a pull request

📖 Learn More

• Mintlify Documentation
• Mintlify CLI Reference
• Swarms API

Todo

• Add tools to the capabilities - next
• Add streaming to the capabilities - done
• Add multi-modal processing to the capabilities

📄 License

This project is licensed under the terms specified in the LICENSE file.