Welcome

Introduction

Introduction

Setup & Installation

Architecture & Design

Architecture

Features & Scenarios

Deployment

Deployment

API Reference

API Reference

Tools & Utilities

Scripts & UtilitiesTroubleshooting

Introduction

Learn about SynapseAI and how to use this documentation

Introduction to SynapseAI

Welcome to SynapseAI - an intelligent B2B wholesale commerce platform that transforms how CPG brands handle ordering, inventory management, and customer interactions.

What is SynapseAI?

SynapseAI is a conversational AI platform built on LangGraph that enables:

  • 🤖 Natural Language Ordering - Let customers order through conversation
  • 📊 Predictive Analytics - AI-powered demand forecasting and inventory optimization
  • 🎯 Smart Campaign Management - Automated promotion creation and targeting
  • 💬 Multi-Channel Support - Web, voice, and WhatsApp interfaces
  • 🔄 Human-in-the-Loop - Approval workflows for high-value decisions

Demo: FlavorFlux Brand

Throughout this documentation, we use FlavorFlux - a fictional adaptive CPG yogurt drink brand - to demonstrate SynapseAI's capabilities.

Who is This For?

This documentation is designed for:

👨‍💻 Developers

Setting up, customizing, and extending the SynapseAI platform

🏗️ DevOps Engineers

Deploying and managing infrastructure on AWS

🎨 Product Managers

Understanding capabilities and user scenarios

🔧 Integration Engineers

Connecting external services and APIs

Documentation Structure

1. Setup & Installation

Step-by-step guides to get SynapseAI running locally:

  • Prerequisites and environment setup
  • Backend installation and configuration
  • Frontend setup and development
  • MCP servers configuration

2. Architecture & Design

Understand how SynapseAI works:

  • System architecture overview
  • LangGraph agent design
  • C4 model diagrams
  • Integration patterns

3. Features & Scenarios

Learn about capabilities:

  • User personas and workflows
  • Conversational AI features
  • Campaign management
  • Inventory optimization

4. Deployment

Take SynapseAI to production:

  • AWS infrastructure setup
  • Terraform configuration
  • Frontend deployment
  • Security and scaling

5. API Reference

Technical API documentation:

  • Chat API endpoints
  • Authentication
  • Campaign management APIs
  • Webhook integration

6. Tools & Utilities

Maintenance and helper scripts:

  • Data synchronization
  • Database migrations
  • Monitoring tools

Quick Start Paths

Path 1: Try It Locally (30 minutes)

  1. Install prerequisites
  2. Run with Docker Compose
  3. Access the chat interface
  4. Try example conversations

Start here: Quick Start Guide

Path 2: Full Development Setup (2 hours)

  1. Set up development environment
  2. Install backend and frontend separately
  3. Configure MCP servers
  4. Enable debugging and hot reload

Start here: Prerequisites

Path 3: Deploy to Production (4 hours)

  1. Review architecture
  2. Configure AWS credentials
  3. Deploy with Terraform
  4. Set up monitoring

Start here: Deployment Guide

Key Technologies

🤖 AI & Orchestration

  • LangGraph
  • LiteLLM
  • AWS Bedrock
  • AWS Forecast

⚡ Backend

  • FastAPI
  • Python 3.11+
  • Redis
  • MCP Protocol

🎨 Frontend

  • React 18
  • Vite
  • TanStack Router
  • Tailwind CSS

External Integrations

SynapseAI integrates with best-in-class services:

  • Commercetools - E-commerce and product catalog
  • Voucherify - Promotions and loyalty programs
  • AWS Services - Cloud infrastructure and AI

Support & Community

Getting Help

  • 📖 Documentation: You're reading it!
  • 💬 Slack: #synapseai-support
  • 📧 Email: support@synapseai.com
  • 🐛 Issues: GitHub Issue Tracker

Contributing

This is an internal project. Contact the development team for contribution guidelines.

What's Next?

Ready to get started? Choose your path:

🚀 Quick Start

Get SynapseAI running in 30 minutes

🔧 Full Setup

Complete development environment

🏗️ Architecture

Understand how it works

🎯 Use Cases

See it in action


Platform Version: 1.0.0
Last Updated: November 2024

Welcome

SynapseAI B2B Wholesale Platform Documentation

Setup Overview

Get SynapseAI running on your machine

On this page

Introduction to SynapseAIWhat is SynapseAI?Demo: FlavorFlux BrandWho is This For?👨‍💻 Developers🏗️ DevOps Engineers🎨 Product Managers🔧 Integration EngineersDocumentation Structure1. Setup & Installation2. Architecture & Design3. Features & Scenarios4. Deployment5. API Reference6. Tools & UtilitiesQuick Start PathsPath 1: Try It Locally (30 minutes)Path 2: Full Development Setup (2 hours)Path 3: Deploy to Production (4 hours)Key TechnologiesExternal IntegrationsSupport & CommunityGetting HelpContributingWhat's Next?