📖Lokam Documentation
Guide 01â€ĸGetting Started

🚀5-Minute Quickstart

Deploy your first AI voice and messaging agent, set up conversation rules, and test live in the browser in under five minutes.

📌User Panel: Account & Workspaces

# 1. Create Your Account

Go to app.lokam.si/register to create your organization account. Every new account gets an instant free trial with 100 free voice minutes and 300 chat sessions so you can test all features without entering a credit card.

â„šī¸No Credit Card Needed

The free trial includes access to the Flow Builder, Gemini voice engine, and webhooks without any billing details.

âš™ī¸Form Fields & Configuration Schema4 fields
Field NameTypeRequiredDefaultDescription & ValidationExample Value
Workspace NamestringRequiredMy OrganizationThe business name of your company or agency.Acme Health Clinic
Workspace SlugstringRequiredauto-generatedA clean web-friendly name used in webhook links and API routes.acme-health
Primary Contact EmailemailRequireduser@example.comMain email address for alerts, billing, and important notifications.ops@acmehealth.com
Default Region / TimezoneselectRequiredUTCYour local timezone for calendar bookings and call schedules.America/New_York (EST)
📌User Panel: Settings > API Keys

# 2. Create an API Key

Go to Settings → API Keys in your dashboard. Create a new API token with the permissions your application needs. You will use this key to authenticate API requests.

âš™ī¸Form Fields & Configuration Schema3 fields
Field NameTypeRequiredDefaultDescription & ValidationExample Value
Key Name / LabelstringRequiredDefault KeyA friendly name so you remember what this key is used for.Website Chat Key
Expiration HorizonselectRequired90 daysHow long the key stays valid: 30 days, 60 days, 90 days, 1 year, or Never.90 days
Permissions (Scopes)multiselectRequiredread-onlyChoose which features this key can access (calling, messaging, contacts, flows).telephony:outbound, messaging:send
📌User Panel: Studio > Agent Flows

# 3. Build Your First Agent Flow

Inside Studio → Agent Flows, create a new flow or use the AI Flow Generator. Simply type what you want your agent to do (for example: "Create a dental appointment agent that confirms bookings and syncs with Google Calendar"). The AI builds the visual flow steps for you.

💡Instant Canvas Sync

Changes made in the visual canvas update instantly across testing, import/export, and live call execution.

💡Production Use Cases & Concrete Examples

✨Clinic Appointment Confirmation Call

Production Blueprint

Scenario: Call patients the day before their visit, confirm their time, or reschedule if they cannot make it.

Configuration: Greeting Node -> Google Calendar Node -> Decision Node (Confirm/Reschedule) -> Transfer to Staff if needed.
Customer Input

Patient: "Hi! Can I move my appointment from 10 AM to 2 PM tomorrow?"

Agent Response

Agent: "I have moved your appointment to tomorrow at 2:00 PM with Dr. Smith. A confirmation text has been sent to your phone."

✓Outcome: 94% of appointments confirmed automatically without staff making phone calls.
📌User Panel: Studio > Sandbox Draft Modal

# 4. Test in the Sandbox

Click "Test Draft" on any flow to open the interactive sandbox. You can type messages to test responses, speak into your computer microphone for live voice testing, or send a real test call to your personal phone.