GigPilot AI - Documentation Portal
Overview: Welcome to the official GigPilot AI developer documentation hub. This portal contains complete architectural guides, REST API endpoint specifications, SDK usage examples, database schemas, security audit matrices, and deployment instructions.
System Overview
GigPilot AI is a comprehensive freelancer toolkit powered by artificial intelligence. It provides gig generation, proposal writing, keyword research, pricing optimization, social media management, and more.
Documentation Structure
| Document | Description |
|---|---|
| Introduction | Platform overview and capabilities |
| Quick Start | Getting started guide |
| Authentication | Auth flow and JWT management |
| Architecture | System architecture and design |
| Folder Structure | Project directory layout |
| Database | Database schema and tables |
| Supabase | Supabase integration details |
| Storage | File storage system |
| Error Handling | Error codes and handling |
| Rate Limits | Rate limiting configuration |
| Pagination | Pagination patterns |
| Security | Security practices and audit |
| Changelog | Version history |
API Documentation
| Document | Description |
|---|---|
| API Index | Master endpoint index |
| API Reference | Response format and conventions |
| OpenAPI Spec | OpenAPI 3.0 specification |
| Webhooks | Webhook documentation |
| SDK Examples | Client SDK examples |
Endpoint Groups
| Document | Description |
|---|---|
| Auth API | Authentication endpoints |
| Users API | User management endpoints |
| AI API | AI generation endpoints |
| Gigs API | Gig management endpoints |
| Projects API | Project endpoints |
| Social API | Social media hub endpoints |
| Analytics API | Analytics dashboard |
| Notifications API | Notification system |
| Storage API | File upload endpoints |
| Payments API | Billing and payments |
| Settings API | User settings |
| Admin API | Admin endpoints |
| Scheduler API | Post scheduler |
| Health API | Health check endpoints |
Base URLs
| Environment | URL |
|---|---|
| Production | https://api.gigpilot.ai |
| Development | http://localhost:3000 |
API Versioning
All endpoints are available under both /api/ and /api/v1/ prefixes. Both versions are identical and point to the same handlers.
Support
- GitHub Issues: https://github.com/anomalyco/gigpilotai/issues