Platform Documentation

This guide explains tool setup, per-tool backend customization, Twilio integration, setup assistant flow, and prompt configuration conventions in an Awaz-style operational format.

Platform Overview

VoiceIQ is a multi-tool AI voice platform where each AI workflow is configured independently and mapped to a dedicated backend profile. This allows specialized behavior for reception, appointments, booking, customer operations, client management, and technical troubleshooting.

Architecture principle: one tool, one backend profile, one clear operational objective.

AI Setup Assistant

The setup assistant provides step-by-step onboarding guidance directly inside the dashboard.

Guide Flow

  1. Select tool and use case scope.
  2. Configure agent behavior and prompt content.
  3. Save Twilio configuration and webhook base URL.
  4. Run live tests and validate logs/transcripts.
  5. Publish docs and handoff notes for operations.

Tool Configuration Fields

Each AI tool includes configurable fields:

  • Agent name
  • Tone
  • Conversational style
  • Personality
  • How the agent should start
  • What the agent should say
  • How the agent should end
  • Specialized prompt template

Order Variables (Custom ORDER_JSON)

Dashboard now supports a non-technical variable builder. You can create/edit/delete variables from simple controls (no manual JSON required), then save per restaurant.

  • Dashboard path: Restaurants -> Open Settings -> Order Capture Variables
  • Each restaurant has its own variable schema
  • Order cards show only variables assigned to that restaurant
  • GET /api/order-schema/restaurant/{restaurant_id} view one restaurant config
  • PUT /api/order-schema/restaurant/{restaurant_id} save one restaurant custom schema
  • POST /api/order-schema/restaurant/{restaurant_id}/reset reset one restaurant config
  • GET /api/order-schema/all list all accessible restaurant schemas
  • POST /api/order-schema/validate dry-run validation

Detailed step-by-step guide: /order-variables

Prompt Optimization

Prompt optimization is managed from the dashboard Prompt Optimizer and uses the restaurant optimizer flow for IVR prompts.

Endpoint: POST /api/prompt/optimize-restaurant

Twilio Integration Guide

Required Inputs

  • Account SID
  • Auth Token
  • Webhook base URL
  • Primary number / default country

Steps

  1. Open dashboard page Twilio Config.
  2. Save credentials and webhook base URL.
  3. In Twilio Console, set incoming voice webhook to /api/incoming-call/{restaurant_id} using HTTP POST.
  4. Place a validation call and verify logs, transcripts, and recording handling.

Website Routes

  • / Home
  • /pricing Pricing
  • /terms Terms of Service
  • /privacy Privacy Policy
  • /docs Documentation
  • /order-variables Custom variable documentation
  • /dashboard Platform Dashboard