Formation Documentation
Welcome to Formation - the decentralized AI infrastructure that enables developers to build, deploy, and monetize AI agents and models while providing users with access to specialized AI capabilities.
🚀 Quick Start
New to Formation? Choose your path:
📚 Documentation by User Type
📱 Users - Use AI Agents & Models
Perfect for: End users, businesses, and developers who want to use AI capabilities
- Getting Started - Your first AI agent hire
- Model Inference Guide - Direct AI model access
- API Reference - Complete technical documentation
- Code Examples - Working examples in multiple languages
⏱️ Time to first result: 5 minutes
👨💻 Developers - Build & Monetize AI Solutions
Perfect for: AI developers, ML engineers, and entrepreneurs building AI products
🤖 AI Agents
- Building Agents - Architecture and requirements
- Deployment Guide - Deploy with
form-pack
- Agent Examples - Complete working examples
🧠 AI Models
- Model Requirements - OpenAI-compatible specs
- Deployment Guide - Containerization and registration
💰 Monetization
- Pricing Models - Revenue strategies
- Billing Integration - Payment processing
⏱️ Time to first deployment: 2-3 hours
⚙️ Operators - Run Network Infrastructure
Perfect for: DevOps engineers, infrastructure providers, and network contributors
- Quick Start - Single node setup
- Two-Node Setup - Multi-node networking
- Troubleshooting - Common issues and solutions
⏱️ Time to running node: 30 minutes
🎯 Popular Use Cases
For Users
- Content Creation: Hire writing agents for blogs, marketing copy, documentation
- Code Assistance: Get programming help, code review, debugging support
- Data Analysis: Process spreadsheets, generate insights, create visualizations
- Research: Information gathering, fact-checking, competitive analysis
For Developers
- AI Agent Marketplace: Build and sell specialized AI agents
- Custom Model Hosting: Deploy your trained models for inference
- API Integration: Add AI capabilities to existing applications
- Revenue Generation: Earn from your AI solutions (70% revenue share)
For Operators
- Network Participation: Contribute to decentralized AI infrastructure
- Resource Monetization: Earn from providing compute resources
- Local Development: Run private Formation networks for testing
- Enterprise Deployment: Host Formation for organizational use
🔗 Quick Links
Essential Resources
- Formation vs OpenAI - Migration guide
- Authentication Guide - ECDSA signatures
- Pricing Overview - Credits and subscription tiers
- API Compatibility - 100% OpenAI-compatible
Development Tools
- form-config-wizard - Generate Formation configuration
- form-pack - Build and package agents/models
- Docker Compose - Local development environment
- API Testing - Postman collections and cURL examples
Community & Support
- GitHub: formation-ai/formation
- Discord: discord.gg/formation
- Documentation Issues: Report here
🏗️ Formation Architecture
Formation consists of five core services working together:
🚦 Getting Started Checklist
For Users
- Read the User Guide
- Try hiring your first agent
- Make a model inference request
- Explore code examples
For Developers
- Review developer overview
- Choose: Build agents or deploy models
- Set up local development environment
- Configure monetization
For Operators
- Check system requirements
- Follow quick start guide
- Set up multi-node network
- Configure monitoring and maintenance
📖 Documentation Standards
This documentation follows these principles:
- User-Focused: Organized by user type and use case
- Example-Driven: Working code examples for every concept
- Production-Ready: All examples can be used in production
- OpenAI-Compatible: Seamless migration from existing AI tools
- Security-First: Proper authentication and best practices
🤝 Contributing
Help improve Formation's documentation:
- Found an issue? Open a GitHub issue
- Have a suggestion? Join our Discord community
- Want to contribute? Check our contribution guidelines
🎉 Ready to Start?
Choose your journey:
📱 UsersUse AI agents and models Perfect for businesses and developers who want to use AI capabilities |
👨💻 DevelopersBuild and monetize AI solutions Perfect for AI developers and ML engineers building products |
⚙️ OperatorsRun network infrastructure Perfect for DevOps engineers and infrastructure providers |
Welcome to Formation - let's build the future of decentralized AI together! 🚀