Need API access? Email devs@helloannie.com to get started.
Prerequisites
- An Annie account with API access
- Your API key
Step 1: Create an Organization
An organization represents a physical location—your practice, clinic, or office. It stores the details your agent needs to answer questions accurately.id from the response—you’ll need it in the next steps.
Organizations Guide
Learn about addresses, office hours, staff, and multi-location setups.
Step 2: Create a Bot
A bot is your AI agent. It handles conversations and can be trained with custom knowledge specific to your organization.Bots Guide
Configure bot settings, integrations, and parent-child relationships.
Step 3: Add Training
Annie supports multiple training modules to teach your agent how to respond—FAQs, insurances, office information, workflows, and more. For this quickstart, we’ll use a template, which bundles common training into a single configuration you can apply to your bot. Templates are pre-built for common use cases like dental scheduling agents or general FAQ agents.Since the API is invite-only, part of your onboarding includes setting up your first template. We’ll add default templates to your account so you can get up and testing quickly—then tweak and fine-tune them later.
Templates may contain variables that must be filled in when applying. The
variables field is required—pass an empty object {} if the template has no variables. Check your template’s variables array to see what values are needed.More documentation on template variables is coming soon.Training Guide
Learn about all the training modules—FAQs, insurances, workflows, and more.
Step 4: Attach a Phone Number
Connect a phone number to your bot so it can receive calls.Phone Numbers Guide
Provision numbers, configure forwarding, and manage number routing.
Step 5: Test Your Agent
Call your phone number. Your agent should answer and respond based on the training you’ve provided.What’s Next?
This quickstart covered the basics, but each step has many more customization options and features. Dive deeper with our guides:Organizations
Addresses, office hours, staff, and multi-location configurations.
Bots
Integrations, parent-child relationships, and advanced settings.
Training
FAQs, insurances, workflows, and how training affects behavior.
Phone Numbers
Provisioning, forwarding, and routing configurations.
Bot Architecture
Architecture patterns for multi-location and enterprise deployments.
API Reference
Full documentation for all endpoints.