Documentation

Complete documentation for Orchesity AI platform, API reference, and integration guides.

Quick Start

Get started with Orchesity AI in minutes

  • Create a free account (no credit card required)
  • Describe your backend requirements in plain English
  • Select from 9 supported frameworks
  • Choose optional features (DWA, AI Router, Infrastructure)
  • Generate your backend in ~60 seconds
  • Download and deploy production-ready code

Supported Frameworks

Build with your preferred technology stack

  • Python: FastAPI, Django
  • Node.js: Express, NestJS
  • Go: Gin framework
  • Java: Spring Boot
  • PHP: Laravel
  • C#: .NET Core
  • Ruby: Ruby on Rails
  • All frameworks include: RESTful APIs, authentication, database models, Docker setup

Database Support

Automatic database configuration and ORM setup

  • PostgreSQL (recommended for production)
  • MySQL/MariaDB
  • MongoDB
  • SQLite (for development)
  • Redis (caching layer)
  • Automatic migrations and seeding
  • Connection pooling and optimization
  • Environment-based configuration

CSG Security Pipeline

Three-stage security validation for all generated code

  • Stage 1: Sanitization - Input validation and SQL injection prevention
  • Stage 2: Validation - Code quality checks, best practices enforcement
  • Stage 3: Security Scanning - Vulnerability detection, dependency auditing
  • All code passes through automated security tests
  • OWASP Top 10 compliance checks
  • Secure authentication patterns (JWT, OAuth2)
  • Environment variable protection
  • Rate limiting and CORS configuration

Generated Code Structure

Organized, production-ready project structure

  • /src - Application source code
  • /models - Database models and schemas
  • /routes - API endpoints and controllers
  • /middleware - Authentication, logging, error handling
  • /config - Environment configuration
  • /tests - Unit and integration tests
  • /docker - Docker and docker-compose files
  • /docs - API documentation (OpenAPI/Swagger)
  • README.md - Setup and deployment instructions

Deployment Guide

Deploy to any cloud provider

  • Step 1: Configure environment variables (.env.production)
  • Step 2: Build Docker image: docker build -t myapp .
  • Step 3: Push to registry (Docker Hub, AWS ECR, GCR)
  • Step 4: Deploy to platform (AWS, GCP, Azure, Heroku, Railway)
  • Included: CI/CD pipeline templates (GitHub Actions, GitLab CI)
  • Health check endpoints: /health, /ready
  • Monitoring: Prometheus metrics, structured logging
  • SSL/TLS configuration and HTTPS redirects

Optional Features

Enhance your backend with add-ons

  • DWA (+2 credits): Database Write API - Advanced CRUD with validation
  • AI Router (+3 credits): Intelligent model selection and failover
  • WebSocket support: Real-time bidirectional communication
  • File upload handling: S3/cloud storage integration
  • Email service: SMTP configuration and templates
  • Cron jobs: Scheduled task management
  • GraphQL API: Alternative to REST endpoints
  • Admin dashboard: Auto-generated CRUD interface

CLI & API

Programmatic access and automation

  • REST API: Generate backends programmatically
  • API Authentication: Bearer token in Authorization header
  • Endpoints: POST /api/generate, GET /api/projects, DELETE /api/projects/:id
  • Rate Limits: 10 req/min (Free), 60 req/min (Starter), 300 req/min (Pro)
  • Webhooks: Receive notifications on generation completion
  • SDKs: Coming soon (Python, Node.js, Go)
  • Example: curl -X POST -H "Authorization: Bearer TOKEN" ...

Example: Generate a Backend

Programmatic backend generation via API

# 1. Sign up and get your API token from dashboard
export ORCHESITY_TOKEN="your_api_token_here"

# 2. Create generation request
curl -X POST https://api.orchesity.ai/v1/generate \
  -H "Authorization: Bearer $ORCHESITY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "E-commerce API with user auth, product catalog, cart, orders",
    "framework": "fastapi",
    "features": {
      "dwa": true,
      "ai_router": true,
      "infrastructure": "growth"
    }
  }'

# 3. Response includes project_id and download URL
# {
#   "project_id": "proj_abc123",
#   "status": "generating",
#   "estimated_time": 60
# }

# 4. Download generated code (after ~60 seconds)
curl -X GET https://api.orchesity.ai/v1/projects/proj_abc123/download \
  -H "Authorization: Bearer $ORCHESITY_TOKEN" \
  -o backend.zip

Credit Cost Calculator

Understand how credits are calculated for each generation

Base Generation (any framework)1 credit
+ DWA (Database Write API)+2 credits
+ AI Router (intelligent routing)+3 credits
+ Infrastructure (Basic/Growth/Scale)+3/+6/+9 credits

Example Calculation:

FastAPI + Growth Infrastructure + DWA + AI Router

1 + 6 + 2 + 3 = 12 credits per generation

Need More Help?

Check out our Help Center for FAQs or contact support for personalized assistance.