Welcome to the comprehensive documentation for the Sentinel API Testing Platform. This documentation covers everything you need to know to use, deploy, and contribute to Sentinel.
Complete guide for users of the Sentinel platform, covering:
- Getting started with Sentinel
- Creating and managing API specifications
- Running different types of tests
- Understanding test results and reports
- Using the web interface
- CI/CD integration
In-depth technical documentation for developers and system administrators:
- Architecture overview
- Service components and interactions
- Agent implementation details
- Database schema and models
- Configuration management
- Security implementation
Complete API documentation with examples:
- REST API endpoints
- Request/response formats
- Authentication and authorization
- Error handling
- Code examples in multiple languages
Everything you need to deploy Sentinel:
- System requirements
- Docker deployment
- Kubernetes deployment
- Production configuration
- Scaling strategies
- Monitoring and observability
Common issues and their solutions:
- Installation problems
- Service connectivity issues
- Performance optimization
- Debugging techniques
- FAQ
- Quick Start Guide
- API Specification Upload
- Running Your First Test
- Understanding Test Results
- CI/CD Integration
- LLM Configuration Guide
- Configuration Scripts
Sentinel is an AI-powered API testing platform that automates the entire testing lifecycle through specialized agents:
- Functional Testing: Positive, negative, and stateful workflow testing
- Security Testing: Authentication, authorization, and injection vulnerability testing
- Performance Testing: Load, stress, and spike testing
- Data Mocking: Intelligent test data generation
- Analytics: Historical trends, anomaly detection, and predictive insights
- Multi-LLM Support: 6+ AI providers including Anthropic Claude, OpenAI, Google Gemini 2.5, and local models
- Hybrid Approach: Combines deterministic algorithms with LLM creativity for superior test generation
- GitHub Issues: Report bugs or request features
- Contributing: See our Contributing Guide
- Code of Conduct: Read our Code of Conduct
This documentation is for Sentinel version 1.0.0 (Production Ready).
- Multi-LLM Provider Support: 6+ providers (Anthropic, OpenAI, Google, Mistral, Ollama, vLLM)
- Test Coverage: 97.8% pass rate (540+ tests)
- Frontend: React-based UI with Playwright E2E testing
- Backend: Microservices architecture with comprehensive test suite
- Configuration Scripts: Interactive LLM management tools
Last updated: August 2025