You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
242 lines
14 KiB
242 lines
14 KiB
# Swarms API Clients
|
|
|
|
*Production-Ready Client Libraries for Every Programming Language*
|
|
|
|
## Overview
|
|
|
|
The Swarms API provides official client libraries across multiple programming languages, enabling developers to integrate powerful multi-agent AI capabilities into their applications with ease. Our clients are designed for production use, featuring robust error handling, comprehensive documentation, and seamless integration with existing codebases.
|
|
|
|
Whether you're building enterprise applications, research prototypes, or innovative AI products, our client libraries provide the tools you need to harness the full power of the Swarms platform.
|
|
|
|
## Available Clients
|
|
|
|
| Language | Status | Repository | Documentation | Description |
|
|
|----------|--------|------------|---------------|-------------|
|
|
| **Python** | ✅ **Available** | [swarms-sdk](https://github.com/The-Swarm-Corporation/swarms-sdk) | [Docs](https://docs.swarms.world/en/latest/swarms_cloud/python_client/) | Production-grade Python client with comprehensive error handling, retry logic, and extensive examples |
|
|
| **TypeScript/Node.js** | ✅ **Available** | [swarms-ts](https://github.com/The-Swarm-Corporation/swarms-ts) | 📚 *Coming Soon* | Modern TypeScript client with full type safety, Promise-based API, and Node.js compatibility |
|
|
| **Go** | ✅ **Available** | [swarms-client-go](https://github.com/The-Swarm-Corporation/swarms-client-go) | 📚 *Coming Soon* | High-performance Go client optimized for concurrent operations and microservices |
|
|
| **Java** | ✅ **Available** | [swarms-java](https://github.com/The-Swarm-Corporation/swarms-java) | 📚 *Coming Soon* | Enterprise Java client with Spring Boot integration and comprehensive SDK features |
|
|
| **Kotlin** | 🚧 **Coming Soon** | *In Development* | 📚 *Coming Soon* | Modern Kotlin client with coroutines support and Android compatibility |
|
|
| **Ruby** | 🚧 **Coming Soon** | *In Development* | 📚 *Coming Soon* | Elegant Ruby client with Rails integration and gem packaging |
|
|
| **Rust** | 🚧 **Coming Soon** | *In Development* | 📚 *Coming Soon* | Ultra-fast Rust client with memory safety and zero-cost abstractions |
|
|
| **C#/.NET** | 🚧 **Coming Soon** | *In Development* | 📚 *Coming Soon* | .NET client with async/await support and NuGet packaging |
|
|
|
|
## Client Features
|
|
|
|
All Swarms API clients are built with the following enterprise-grade features:
|
|
|
|
### 🔧 **Core Functionality**
|
|
|
|
| Feature | Description |
|
|
|------------------------|--------------------------------------------------------------------|
|
|
| **Full API Coverage** | Complete access to all Swarms API endpoints |
|
|
| **Type Safety** | Strongly-typed interfaces for all request/response objects |
|
|
| **Error Handling** | Comprehensive error handling with detailed error messages |
|
|
| **Retry Logic** | Automatic retries with exponential backoff for transient failures |
|
|
|
|
---
|
|
|
|
### 🚀 **Performance & Reliability**
|
|
|
|
| Feature | Description |
|
|
|--------------------------|--------------------------------------------------------------------|
|
|
| **Connection Pooling** | Efficient HTTP connection management |
|
|
| **Rate Limiting** | Built-in rate limit handling and backoff strategies |
|
|
| **Timeout Configuration**| Configurable timeouts for different operation types |
|
|
| **Streaming Support** | Real-time streaming for long-running operations |
|
|
|
|
---
|
|
|
|
### 🛡️ **Security & Authentication**
|
|
|
|
| Feature | Description |
|
|
|------------------------|--------------------------------------------------------------------|
|
|
| **API Key Management** | Secure API key handling and rotation |
|
|
| **TLS/SSL** | End-to-end encryption for all communications |
|
|
| **Request Signing** | Optional request signing for enhanced security |
|
|
| **Environment Configuration** | Secure environment-based configuration |
|
|
|
|
---
|
|
|
|
### 📊 **Monitoring & Debugging**
|
|
|
|
| Feature | Description |
|
|
|----------------------------|--------------------------------------------------------------------|
|
|
| **Comprehensive Logging** | Detailed logging for debugging and monitoring |
|
|
| **Request/Response Tracing** | Full request/response tracing capabilities |
|
|
| **Metrics Integration** | Built-in metrics for monitoring client performance |
|
|
| **Debug Mode** | Enhanced debugging features for development |
|
|
|
|
|
|
## Client-Specific Features
|
|
|
|
### Python Client
|
|
|
|
| Feature | Description |
|
|
|------------------------|----------------------------------------------------------|
|
|
| **Async Support** | Full async/await support with `asyncio` |
|
|
| **Pydantic Integration** | Type-safe request/response models |
|
|
| **Context Managers** | Resource management with context managers |
|
|
| **Rich Logging** | Integration with Python's `logging` module |
|
|
|
|
---
|
|
|
|
### TypeScript/Node.js Client
|
|
|
|
| Feature | Description |
|
|
|------------------------|----------------------------------------------------------|
|
|
| **TypeScript First** | Built with TypeScript for maximum type safety |
|
|
| **Promise-Based** | Modern Promise-based API with async/await |
|
|
| **Browser Compatible** | Works in both Node.js and modern browsers |
|
|
| **Zero Dependencies** | Minimal dependency footprint |
|
|
|
|
---
|
|
|
|
### Go Client
|
|
|
|
| Feature | Description |
|
|
|------------------------|----------------------------------------------------------|
|
|
| **Context Support** | Full context.Context support for cancellation |
|
|
| **Structured Logging** | Integration with structured logging libraries |
|
|
| **Concurrency Safe** | Thread-safe design for concurrent operations |
|
|
| **Minimal Allocation** | Optimized for minimal memory allocation |
|
|
|
|
---
|
|
|
|
### Java Client
|
|
|
|
| Feature | Description |
|
|
|------------------------|----------------------------------------------------------|
|
|
| **Spring Boot Ready** | Built-in Spring Boot auto-configuration |
|
|
| **Reactive Support** | Optional reactive streams support |
|
|
| **Enterprise Features**| JMX metrics, health checks, and more |
|
|
| **Maven & Gradle** | Available on Maven Central |
|
|
|
|
## Advanced Configuration
|
|
|
|
### Environment Variables
|
|
|
|
All clients support standard environment variables for configuration:
|
|
|
|
```bash
|
|
# API Configuration
|
|
SWARMS_API_KEY=your_api_key_here
|
|
SWARMS_BASE_URL=https://api.swarms.world
|
|
|
|
# Client Configuration
|
|
SWARMS_TIMEOUT=60
|
|
SWARMS_MAX_RETRIES=3
|
|
SWARMS_LOG_LEVEL=INFO
|
|
```
|
|
|
|
## Community & Support
|
|
|
|
### 📚 **Documentation & Resources**
|
|
|
|
| Resource | Link |
|
|
|-----------------------------|----------------------------------------------------------------------------------------|
|
|
| Complete API Documentation | [View Docs](https://docs.swarms.world/en/latest/swarms_cloud/swarms_api/) |
|
|
| Python Client Docs | [View Docs](https://docs.swarms.world/en/latest/swarms_cloud/python_client/) |
|
|
| API Examples & Tutorials | [View Examples](https://docs.swarms.world/en/latest/examples/) |
|
|
|
|
---
|
|
|
|
### 💬 **Community Support**
|
|
|
|
| Community Channel | Description | Link |
|
|
|-----------------------------|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
|
|
| Discord Community | Join our active developer community for real-time support and discussions | [Join Discord](https://discord.gg/jM3Z6M9uMq) |
|
|
| GitHub Discussions | Ask questions and share ideas | [GitHub Discussions](https://github.com/The-Swarm-Corporation/swarms/discussions) |
|
|
| Twitter/X | Follow for updates and announcements | [Twitter/X](https://x.com/swarms_corp) |
|
|
|
|
---
|
|
|
|
### 🐛 **Issue Reporting & Contributions**
|
|
|
|
| Contribution Area | Description | Link |
|
|
|-----------------------------|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
|
|
| Report Bugs | Help us improve by reporting issues | [Report Bugs](https://github.com/The-Swarm-Corporation/swarms/issues) |
|
|
| Feature Requests | Suggest new features and improvements | [Feature Requests](https://github.com/The-Swarm-Corporation/swarms/issues) |
|
|
| Contributing Guide | Learn how to contribute to the project | [Contributing Guide](https://docs.swarms.world/en/latest/contributors/main/) |
|
|
|
|
---
|
|
|
|
### 📧 **Direct Support**
|
|
|
|
| Support Type | Contact Information |
|
|
|-----------------------------|---------------------------------------------------------------------------------------|
|
|
| Support Call | [Book a call](https://cal.com/swarms/swarms-technical-support?overlayCalendar=true) |
|
|
| Enterprise Support | Contact us for dedicated enterprise support options |
|
|
|
|
|
|
## Contributing to Client Development
|
|
|
|
We welcome contributions to all our client libraries! Here's how you can help:
|
|
|
|
### 🛠️ **Development**
|
|
|
|
| Task | Description |
|
|
|-----------------------------------------|--------------------------------------------------|
|
|
| Implement new features and endpoints | Add new API features and expand client coverage |
|
|
| Improve error handling and retry logic | Enhance robustness and reliability |
|
|
| Add comprehensive test coverage | Ensure code quality and prevent regressions |
|
|
| Optimize performance and memory usage | Improve speed and reduce resource consumption |
|
|
|
|
---
|
|
|
|
### 📝 **Documentation**
|
|
|
|
| Task | Description |
|
|
|-----------------------------|-----------------------------------------------------|
|
|
| Write tutorials and examples | Create guides and sample code for users |
|
|
| Improve API documentation | Clarify and expand reference docs |
|
|
| Create integration guides | Help users connect clients to their applications |
|
|
| Translate documentation | Make docs accessible in multiple languages |
|
|
|
|
---
|
|
|
|
### 🧪 **Testing**
|
|
|
|
| Task | Description |
|
|
|-------------------------------|-----------------------------------------------------|
|
|
| Add unit and integration tests | Test individual components and end-to-end flows |
|
|
| Test with different language versions | Ensure compatibility across environments |
|
|
| Performance benchmarking | Measure and optimize speed and efficiency |
|
|
| Security testing | Identify and fix vulnerabilities |
|
|
|
|
---
|
|
|
|
### 📦 **Packaging**
|
|
|
|
| Task | Description |
|
|
|-------------------------------|-----------------------------------------------------|
|
|
| Package managers (npm, pip, Maven, etc.) | Publish to popular package repositories |
|
|
| Distribution optimization | Streamline builds and reduce package size |
|
|
| Version management | Maintain clear versioning and changelogs |
|
|
| Release automation | Automate build, test, and deployment pipelines |
|
|
|
|
## Enterprise Features
|
|
|
|
For enterprise customers, we offer additional features and support:
|
|
|
|
### 🏢 **Enterprise Client Features**
|
|
|
|
| Feature | Description |
|
|
|--------------------------|----------------------------------------------------------------|
|
|
| **Priority Support** | Dedicated support team with SLA guarantees |
|
|
| **Custom Integrations** | Tailored integrations for your specific needs |
|
|
| **On-Premises Deployment** | Support for on-premises or private cloud deployments |
|
|
| **Advanced Security** | Enhanced security features and compliance support |
|
|
| **Training & Onboarding**| Comprehensive training for your development team |
|
|
|
|
### 📞 **Contact Enterprise Sales**
|
|
|
|
| Contact Type | Details |
|
|
|----------------|-----------------------------------------------------------------------------------------|
|
|
| **Sales** | [kye@swarms.world](mailto:kye@swarms.world) |
|
|
| **Schedule Demo** | [Book a Demo](https://cal.com/swarms/swarms-technical-support?overlayCalendar=true) |
|
|
| **Partnership**| [kye@swarms.world](mailto:kye@swarms.world) |
|
|
|
|
---
|
|
|
|
*Ready to build the future with AI agents? Start with any of our client libraries and join our growing community of developers building the next generation of intelligent applications.* |