Welcome to PromptCompose
PromptCompose is a comprehensive platform for managing AI prompts, templates, variable groups, and A/B testing campaigns. Whether you’re managing prompts through our web application or integrating with our SDK, this documentation will help you get the most out of PromptCompose.
What is PromptCompose?
PromptCompose provides a complete solution for AI prompt engineering and management with:
- Web Application: Angular-based interface for prompt management, template creation, and A/B testing
- SDK Integration: JavaScript/TypeScript SDK for seamless API integration
- Unified Experience: Consistent workflow between platform and code
Getting Started
Choose your path to get started with PromptCompose:
🖥️ Platform Users
If you’re managing prompts through our web application:
- Platform Setup - Create your account and first project
- Dashboard Overview - Understand your project dashboard
- Prompt Management - Create and version your prompts
💻 Developers
If you’re integrating PromptCompose into your applications:
- SDK Installation - Install and configure the SDK
- Quick Start Guide - Your first API integration
- API Reference - Complete SDK documentation
Core Concepts
Projects
Everything in PromptCompose is organized within projects, providing:
- Resource isolation and organization
- Team collaboration spaces
- API key management
- Member access control
Resources
PromptCompose manages four main types of resources:
- Prompts - Versioned AI prompts with variable support
- Templates - Reusable prompt structures
- Variable Groups - Collections of typed variables
- A/B Tests - Experiments for prompt optimization
Integration
Seamlessly connect your platform work with code:
- Create and test prompts in the web interface
- Deploy them via API keys and SDK integration
- Run A/B tests and track performance
- Iterate based on real-world data
Key Features
🎛️ Unified Dashboard
- Real-time overview of all resources
- Active A/B test monitoring
- Cross-platform resource management
- Performance tracking and analytics
📝 Advanced Prompt Management
- Monaco Editor with syntax highlighting
- Version control with deployment history
- Variable interpolation and validation
- Cross-project sharing and templates
🧪 Sophisticated A/B Testing
- Multiple rollout strategies (weighted, sequential, manual)
- Real-time performance tracking
- SDK-integrated conversion reporting
- Automated statistical analysis
⚙️ Developer Experience
- TypeScript SDK with full type safety
- Comprehensive error handling
- Local development support
- Production-ready configurations
Documentation Structure
Platform Documentation
Learn how to use the PromptCompose web application:
- Getting Started - Account setup and first project
- Dashboard - Project overview and monitoring
- Prompts - Creating and managing prompts
- Templates - Reusable prompt templates
- Variable Groups - Centralized variable management
- A/B Testing - Setting up experiments
- Settings - User and project configuration
- Integrations - API keys and connections
SDK Documentation
Integrate PromptCompose into your applications:
- Installation - Setup and configuration
- Getting Started - First integration steps
- API Reference - Complete method documentation
- A/B Testing Guide - Advanced testing patterns
- Best Practices - Production recommendations
- Examples - Common implementation patterns
Resources
Additional help and references:
- Troubleshooting - Common issues and solutions
- FAQ - Frequently asked questions
- Changelog - Product updates and releases
Quick Navigation
| I want to… | Go to |
|---|---|
| Set up my account and create prompts | Platform Getting Started |
| Integrate PromptCompose into my app | SDK Installation |
| Learn about A/B testing | Platform A/B Testing or SDK A/B Testing |
| Find API documentation | SDK API Reference |
| Understand variable management | Platform Variables |
| Get help with issues | Troubleshooting |
Support
Need help? We’ve got you covered:
- Documentation: Browse our comprehensive guides
- Community: Join discussions and get peer support
- Support: Contact our team for technical assistance
- GitHub: Report issues and contribute
Ready to get started? Choose your path: