FAQs

FAQs are the simplest form of training—question-answer pairs that teach your agent specific information. They’re organization-specific, so each location can have its own set, and each FAQ is attached to the bots that should use it. Use FAQs for:

Common questions with straightforward answers
Location-specific policies (cancellation, parking, payments)
Information that doesn’t require back-and-forth conversation

Creating an FAQ

const response = await fetch(
  "https://api.helloannie.com/v1/organizations/YOUR_ORG_ID/faqs",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      title: "What insurance do you accept?",
      content: "We accept most major dental insurance plans including Delta Dental, Cigna, and Aetna. We also offer payment plans for patients without insurance.",
      botIds: ["YOUR_BOT_ID"]
    })
  }
)

import requests

response = requests.post(
    "https://api.helloannie.com/v1/organizations/YOUR_ORG_ID/faqs",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "title": "What insurance do you accept?",
        "content": "We accept most major dental insurance plans including Delta Dental, Cigna, and Aetna. We also offer payment plans for patients without insurance.",
        "botIds": ["YOUR_BOT_ID"]
    }
)

curl -X POST https://api.helloannie.com/v1/organizations/YOUR_ORG_ID/faqs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "What insurance do you accept?",
    "content": "We accept most major dental insurance plans including Delta Dental, Cigna, and Aetna. We also offer payment plans for patients without insurance.",
    "botIds": ["YOUR_BOT_ID"]
  }'

FAQ Fields

string

required

The question or topic this FAQ addresses. Annie uses this to match caller questions. Up to 191 characters.Example: "What is your cancellation policy?"

string

required

The answer Annie should give when this FAQ matches. Up to 1,000 characters. Annie reads it aloud, so write it the way you would say it: a sentence or two, without links, lists, or formatting.Example: "We require 24 hours notice to cancel or reschedule. Missed appointments may incur a $50 fee."

array

required

The bots that should use this FAQ. At least one is required, because a bot only uses the FAQs attached to it. When you update an FAQ, botIds replaces the current list; leave it out to keep the current bots.

FAQs API

See the full API reference for FAQ endpoints.

Get Started

Guides

Creating an FAQ

FAQ Fields

FAQs API