Skip to main content

AI Agent RAG Knowledge Base

Comprehensive knowledge base optimized for AI agent retrieval-augmented generation (RAG).

Purpose

This document serves as the primary knowledge source for Olympus Cloud AI agents. It provides structured information for RAG-based retrieval, enabling agents like Maximus (Cockpit AI), Minerva (Sales AI), and others to answer queries accurately.


Platform Overview

What is Olympus Cloud?

Olympus Cloud is an Autonomous Restaurant Operating System (aROS) that combines:

  • Point of Sale (POS) - Order entry, payments, table management
  • Kitchen Display System (KDS) - Order routing, ticket management
  • Workforce Management - Scheduling, time clock, team communication
  • AI Operations - Voice ordering, intelligent insights, automation
  • Edge Computing - Offline-capable on-premise servers (OlympusEdge)

Platform Products

ProductDomainAudience
Restaurant Revolutionrestaurantrevolution.aiRestaurant customers
Olympus Cloudolympuscloud.aiEnterprise/workforce
Creators Revolutioncreatorsrevolution.aiContent creators

Key Differentiators

  1. Offline Resilience - Full operation without internet via OlympusEdge
  2. AI-First Design - Voice AI, intelligent recommendations, automation
  3. Radical Flexibility - Policy engine adapts to any business model
  4. Multi-Tenant Architecture - Enterprise-grade isolation and scaling

Shell Types

Restaurant Shells (restaurantrevolution.ai)

ShellUsersPrimary Functions
Staff ShellServers, hosts, bartendersOrder entry, payments, tables
Customer ShellDiners (mobile app)Browse menu, order, pay, track
Kiosk ShellSelf-service customersSelf-order, payment
KDS ShellKitchen staffView tickets, mark complete
Drive-Thru ShellDrive-thru staffVoice AI ordering, payments
Digital SignageMenu boardsDisplay menus, promotions

Platform Shells (olympuscloud.ai)

ShellUsersPrimary Functions
Platform PortalBusiness usersDashboard, analytics, settings
Platform AdminNebusAI adminsTenant management, support
CockpitOperations teamMonitoring, alerts, AI ops
WorkforceAll employeesScheduling, time clock, chat

Creator Shells (creatorsrevolution.ai)

ShellUsersPrimary Functions
Creator StudioContent creatorsBuild AI personas
Audience ShellFansInteract with AI personas

API Reference Summary

Authentication

EndpointMethodPurpose
/api/v1/auth/loginPOSTUser login
/api/v1/auth/logoutPOSTUser logout
/api/v1/auth/refreshPOSTRefresh token
/api/v1/auth/mfa/verifyPOSTMFA verification

Orders

EndpointMethodPurpose
/api/v1/ordersGETList orders
/api/v1/ordersPOSTCreate order
/api/v1/orders/{id}GETGet order details
/api/v1/orders/{id}/itemsPOSTAdd item to order
/api/v1/orders/{id}/sendPOSTSend to kitchen
/api/v1/orders/{id}/closePOSTClose/complete order

Payments

EndpointMethodPurpose
/api/v1/paymentsPOSTProcess payment
/api/v1/payments/{id}/refundPOSTProcess refund
/api/v1/payments/{id}/voidPOSTVoid payment
/api/v1/payments/tipsPOSTAdd tip
EndpointMethodPurpose
/api/v1/menusGETList menus
/api/v1/menus/{id}/itemsGETGet menu items
/api/v1/items/{id}/modifiersGETGet item modifiers
/api/v1/items/{id}/availabilityPUTUpdate availability

Tables

EndpointMethodPurpose
/api/v1/tablesGETList tables
/api/v1/tables/{id}/statusPUTUpdate table status
/api/v1/tables/{id}/assignPOSTAssign server
/api/v1/reservationsPOSTCreate reservation

Workforce

EndpointMethodPurpose
/api/v1/schedule/shiftsGETList shifts
/api/v1/timeclock/punchPOSTClock in/out
/api/v1/timeclock/breaksPOSTStart/end break
/api/v1/team/messagesPOSTSend team message

Common Questions & Answers

Orders

Q: How do I create a new order? A: Use POST /api/v1/orders with location_id and order_type (dine_in, takeout, delivery). Then add items with POST /api/v1/orders/{id}/items.

Q: How do I send an order to the kitchen? A: Use POST /api/v1/orders/{id}/send. This creates KDS tickets for all kitchen items.

Q: Can I modify an order after sending to kitchen? A: Yes, add items with POST /api/v1/orders/{id}/items. New items create additional tickets. To remove items, use the void endpoint.

Q: How does order routing work? A: Items are routed to appropriate KDS stations based on item category and prep station configuration. Each station receives only relevant items.

Payments

Q: What payment methods are supported? A: Credit/debit cards (Stripe), cash, gift cards, Apple Pay, Google Pay, and split payments combining multiple methods.

Q: How do I process a split payment? A: Create multiple payment records against the same order. Each payment can be a different method. Total must equal order total.

Q: How do I handle tips? A: Tips can be added during payment (pre-auth) or after (tip adjust). Use POST /api/v1/payments/tips with payment_id and tip_amount.

Q: How do refunds work? A: Use POST /api/v1/payments/{id}/refund with amount. Partial refunds are supported. Full refunds available up to 90 days.

Tables & Reservations

Q: How do I check table availability? A: Use GET /api/v1/tables?status=available for current availability. For reservations, use GET /api/v1/reservations/availability?date={date}&party_size={size}.

Q: How does the waitlist work? A: Customers are added via POST /api/v1/waitlist with party size and contact info. When table is ready, they receive SMS notification.

Q: Can tables be combined? A: Yes, use POST /api/v1/tables/merge with table IDs. Combined tables function as single unit for ordering.

Workforce

Q: How do employees clock in? A: Staff use PIN or biometric in Staff Shell, or call POST /api/v1/timeclock/punch with action=clock_in.

Q: How are schedules created? A: Managers create shifts in Platform Portal or via API. AI can auto-generate schedules based on forecasted demand.

Q: How do shift swaps work? A: Employee requests swap, colleague accepts, manager approves (if configured). All via Workforce Shell or API.

Offline Mode

Q: What works offline? A: Order entry, payments (queued), time clock, KDS, and reporting (local data only). Full sync occurs on reconnect.

Q: How long can a location operate offline? A: Indefinitely with OlympusEdge. Local database and processing handles all operations. Payments queue and process on reconnect.

Q: How do I check sync status? A: Use GET /api/v1/sync/status/{location_id} or check Sync Status in Platform Portal dashboard.


Sub-Pages

  • Indexing - How indexing works, embedding models, document chunking
  • Querying - Query patterns, retrieval strategies, re-ranking
  • Entities - Entity definitions, key concepts, relationships
  • Maintenance - Index maintenance, updates, monitoring