OurMenu OS Developer Architecture & API Reference
Build custom integrations, automate real-time order dispatch, connect ESC/POS hardware peripherals, or equip autonomous AI agents with the OurMenu OS protocol suite.
1. Authentication & Agent Registration (Auth.md & RFC 8414)
All merchant and administrative API endpoints require standard HTTP Bearer token authentication in the Authorization header. Autonomous AI agents can self-register using the WorkOS Auth.md specification.
https://ourmenuos.online/api
# Example Request Header
Authorization: Bearer <YOUR_MERCHANT_SECRET_KEY>
Content-Type: application/json
OIDC Config: /.well-known/openid-configuration
OAuth Authz: /.well-known/oauth-authorization-server
Protected Res: /.well-known/oauth-protected-resource
2. Public & Merchant REST Endpoints
/api/chatFrontline AI Concierge Stream
Sends conversational guest queries to the venue-grounded Tego AI concierge. Returns streaming token responses with zero hallucination guarantee and automatic staff handoff routing.
/api/ai/parse-menuMultimodal Menu & Inventory OCR
Ingests physical menu pictures, PDF invoices, or camera frames to parse categories, items, prices, dietary tags, and descriptions into structured JSON.
/api/ai/live-tokenLive Gemini Ephemeral Token Minting
Mints short-lived cryptographic session tokens for direct bidirectional WebAudio (16kHz in / 24kHz out) and 1 FPS camera video streaming via Gemini 3.1 Flash Live.
/api/ordersOrders & Transaction Dispatch
Submits guest orders with table numbers, variant selections, split bill instructions, and payment tokens. Real-time updates push directly to kitchen display systems via WebSockets.
/api/bookingsAppointments & Service Scheduling
Queries availability calendars for spas, clinics, salons, and consultants. Confirms booking reservations with deposit processing.
/api/healthPlatform Health & Status
Real-time operational health telemetry for load balancers, orchestrators, and automated agents.
3. Extended Hardware & Operational Capabilities
OurMenu OS bridges web software directly to physical point-of-sale hardware and multi-branch franchise operations:
Zero-Daemon ESC/POS Printing
Direct raw binary ticket printing over WebUSB, WebSerial (RS232), and WebBluetooth. Sends cash drawer kick pulses (ESC p) and hardware paper cuts without background daemons.
Real-Time Staff Intercom
Low-latency push-to-talk voice radio, kitchen-to-server ready chimes, table assistance calls, and live floor dispatch coordination over WebSockets.
1-Second Catalog Duplication
Franchise and supermarket fleet expansion with instant sub-department cloning (duplicatePageAction), shared inventory, and localized pricing tiers.
Customer IOU Tab Financing
In-house Buy Now Pay Later tab ledger, customer credit limits, automated SMS/email debt reminders, and merchant risk controls.
Payment Roulette Bill Splitter
Gamified dining checkout randomizer and public web tool at /tools/who-pays-the-bill to settle table tabs interactively.
Multi-Gateway Settlement
Unified payments supporting Cards, Bank Transfers, USSD, Apple/Google Pay, and crypto (USDC, USDT, SOL) via Paystack, Bachs, and x402.
4. Webhook Infrastructure
OurMenu OS handles real-time payment gateway settlement callbacks from Paystack and Bachs at /api/paystack/webhook. Every webhook payload is verified using HMAC SHA512 signatures via the x-paystack-signature header.
- charge.success: Automatically updates order payment status and triggers thermal kitchen ticket printing.
- transfer.success: Confirms automated merchant split payouts and affiliate commission disbursements.
5. Supported Machine Standards & Discovery Protocols
OurMenu OS is engineered for total autonomous agent interoperability, implementing 14 cutting-edge open web and AI agent discovery specifications:
Emits HTTP Link response headers advertising api-catalog, service-doc, service-desc, oauth, and skills.
Advertised via /.well-known/api-catalog with application/linkset+json.
Advertised via /.well-known/openid-configuration and /.well-known/oauth-authorization-server.
Published at /.well-known/oauth-protected-resource.
Instructions served at /auth.md for programmatic credential onboarding.
Published at /.well-known/agent-skills/index.json with SHA-256 digests.
Exposed dynamically via navigator.modelContext.provideContext().
Available at /.well-known/ai-catalog.json with URNs and embedding queries.
HTTP 402 agent settlement at /.well-known/x402.json and /.well-known/mpp.json.
Universal Commerce Profile at /.well-known/ucp and ACP at /.well-known/acp.json.
Configured via SVCB/HTTPS records at _index._agents.ourmenuos.online and /.well-known/dns-aid.json.
Declared in /robots.txt (Content-Signal: ai-train=no, search=yes, ai-input=yes).