Home

Gatewayz Backend - Developer Wiki

Welcome to the Gatewayz Universal Inference API Developer Documentation Hub

This wiki provides comprehensive documentation for developers working on the Gatewayz backend. Use this as your central resource for setup, features, deployment, and operations.

---

📚 Quick Navigation

• 🚀 Getting Started
• ⚙️ Setup & Configuration
• ✨ Features & Functionality
• 🚢 Deployment
• 📊 Monitoring & Observability
• 🔌 Integrations
• 🛠️ Operations & Maintenance
• 🔄 CI/CD & Workflows
• 📖 API Documentation
• 🐛 Troubleshooting

---

🚀 Getting Started

New to the project? Start here!

Document	Description
README	Main project overview and quick start
CLAUDE.md	Comprehensive codebase context for AI assistants
Setup Guide	Local development setup instructions
Complete Setup Guide	End-to-end setup walkthrough
Environment Setup	Environment variables and configuration
Architecture Overview	System architecture and design patterns

First-Time Setup Checklist

1. ✅ Clone repository
2. ✅ Install dependencies: pip install -r requirements.txt
3. ✅ Set up environment variables (see Environment Setup)
4. ✅ Configure Supabase (see Setup Guide)
5. ✅ Run local server: python src/main.py
6. ✅ Test endpoints: http://localhost:8000/health

---

⚙️ Setup & Configuration

Environment configuration and service integrations

Essential Setup

Document	Description
Environment Variables	All environment variables explained
API Key Setup	API key generation and management
Branch Protection Setup	GitHub branch protection rules

Service Authentication

Document	Description
Google OAuth2 JWT Setup	JWT authentication for Google services
Google OAuth2 Quick Start	Quick setup for Google authentication
Google Vertex Setup	Google Vertex AI configuration
Vertex AI Setup	Alternative Vertex AI setup guide

---

✨ Features & Functionality

Feature documentation and implementation guides

Core Features

Document	Description
Activity Logging	User activity tracking and audit logs
Referral System	Referral program implementation
Stripe Integration	Payment processing and subscriptions
Statsig Feature Flags	Feature flag management
Release Tracking	Version and release management

Model Management

Document	Description
Model Health Overview	Model health tracking system
Model Health Quick Start	Quick setup for model health
Model Health API Spec	API specification
Model Health UI Mockups	Frontend UI designs
Model Sync	Model catalog synchronization
Model Sync Quickstart	Quick sync setup
Private Models Filter	Filtering private models
Health & Availability API	Model availability checking

Pricing System

Document	Description
Pricing System Index	Main pricing documentation hub
Pricing Quick Start	Quick pricing setup
Pricing Implementation Summary	Implementation details
Pricing Audit System	Audit and verification
Pricing Audit Comparison	Detailed comparison data
GPT-5 Pricing Reference	GPT-5 specific pricing
GPT-5.1 Implementation Guide	GPT-5.1 integration

Automation

Document	Description
Auto-Merge Implementation	Automated PR merging
Auto-Merge Quick Start	Quick setup for auto-merge
Legacy API Key Migration	Migrating old API keys

---

🚢 Deployment

Production deployment guides and configurations

Railway Deployment

Document	Description
Railway Quick Start	⭐ Start here for Railway
Railway Setup Checklist	Step-by-step checklist
Railway Initial Setup	First-time Railway setup
Railway Deployment Guide	Complete deployment guide
Railway Autonomous Deployment	Automated deployments
Railway Error Monitoring	Error monitoring setup
Railway Prometheus Setup	Metrics with Prometheus

Auto-Deployment

Document	Description
Auto-Deploy Quick Start	⭐ Quick deployment setup
Auto-Deployment Architecture	Architecture overview
Auto-Deployment Setup	Detailed setup guide
Auto-Deployment Getting Started	Getting started guide

Other Platforms

Document	Description
Vercel Deployment	Serverless deployment on Vercel
General Deployment Guide	Platform-agnostic deployment
Deploy Migrations	Database migration deployment

---

📊 Monitoring & Observability

Monitoring, logging, and performance tracking

Quick Starts

Document	Description
Observability Quick Start	⭐ Start here for monitoring
Error Monitoring Quick Start	Quick error tracking setup
Performance Monitoring Quick Start	Quick performance setup

Error Tracking

Document	Description
Error Monitoring	Complete error monitoring guide
PostHog Error Tracking	PostHog integration
Sentry Error Capture	Sentry implementation
Sentry Quick Reference	Sentry quick reference

Performance Monitoring

Document	Description
Performance Monitoring	Performance tracking system
Performance Optimization	Optimization strategies

Observability Platforms

Document	Description
OpenTelemetry Setup	OpenTelemetry integration
Prometheus Setup	Prometheus metrics
Grafana Setup	Grafana dashboards

---

🔌 Integrations

Third-party service integrations

Document	Description
Integration Guide	General integration guide
Alibaba Cloud Integration	Alibaba Cloud setup
Google Vertex Migration	Migrating to Vertex AI
Frontend Model Health Integration	Frontend integration guide

---

🛠️ Operations & Maintenance

Day-to-day operations and maintenance

Document	Description
Operations Guide	Operational procedures
Auth Timeout Fixes	Authentication timeout issues

---

🔄 CI/CD & Workflows

Continuous Integration and Deployment workflows

Workflow Testing

Document	Description
Testing Workflows Locally	⭐ Test with act locally
Testing Workflows Quick Guide	Quick reference card

Database Migrations

Document	Description
Supabase Migrations CI	⭐ Automated migrations setup
Supabase Migrations Setup	Setup checklist

API Testing

Document	Description
Apidog Runner Quick Start	⭐ API testing quick start
Apidog Runner Setup	Detailed setup guide
Apidog Runner Summary	Implementation summary

---

📖 API Documentation

API endpoints and usage

Document	Description
API Reference	Complete API documentation
Architecture	API architecture and design

---

🐛 Troubleshooting

Common issues and solutions

Document	Description
Troubleshooting Guide	Common issues and fixes
Auth Timeout Fixes	Authentication timeouts

---

📦 Archive

Historical documentation (for reference)

Document	Description
Implementation Summary	Historical implementation notes

---

🔍 Search Tips

Finding what you need:

• Setup issues? → Check Setup & Configuration
• New feature? → Check Features & Functionality
• Deploying? → Check Deployment (start with Quick Starts)
• Errors/monitoring? → Check Monitoring & Observability
• CI/CD issues? → Check CI/CD & Workflows
• API questions? → Check API Documentation
• Something broken? → Check Troubleshooting

---

🚀 Quick Links

Most frequently accessed documents:

1. Testing Workflows Locally - Test GitHub Actions with act
2. Supabase Migrations CI - Automated database migrations
3. Railway Quick Start - Deploy to Railway
4. Observability Quick Start - Set up monitoring
5. Complete Setup Guide - Full development setup
6. Model Health Quick Start - Model health tracking
7. Pricing Quick Start - Pricing system setup
8. API Reference - API endpoints documentation

---

🤝 Contributing

Adding new documentation?

1. Create your .md file in the appropriate subdirectory:

   • docs/setup/ - Setup and configuration
   • docs/features/ - Feature documentation
   • docs/deployment/ - Deployment guides
   • docs/monitoring/ - Monitoring and observability
   • docs/integrations/ - Third-party integrations

2. Add your document to this wiki index

3. Follow the existing documentation format

4. Include code examples where applicable

5. Add a "Quick Start" section for complex topics

---

📝 Documentation Standards

When creating new docs:

• ✅ Use clear, descriptive titles
• ✅ Include a table of contents for long docs
• ✅ Add code examples with syntax highlighting
• ✅ Provide both detailed and quick-start versions
• ✅ Include troubleshooting sections
• ✅ Keep the wiki index updated
• ✅ Cross-reference related documents

---

📊 Documentation Statistics

• Total Documents: 76+ markdown files
• Categories: 10 main sections
• Quick Starts: 15+ quick reference guides
• Setup Guides: 12+ configuration guides
• Feature Docs: 25+ feature implementations
• Deployment Guides: 13+ platform-specific guides

---

🔗 External Resources

• GitHub Repository: gatewayz-backend
• Supabase Dashboard: supabase.com/dashboard
• Railway Dashboard: railway.app
• Statsig Dashboard: statsig.com
• PostHog Dashboard: posthog.com

---

Last Updated: 2025-11-26 Maintained By: Gatewayz Development Team Questions? Open an issue or consult the relevant documentation section above.