Skip to main content
POST
/
bots
Create bot
curl --request POST \
  --url https://api.helloannie.com/v1/bots \
  --header 'Content-Type: application/json' \
  --data '
{
  "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "greeting": "<string>",
  "internalName": "<string>",
  "companyName": "<string>",
  "industry": "DENTAL",
  "phoneGreeting": "<string>",
  "closedChatGreeting": "<string>",
  "closedPhoneGreeting": "<string>",
  "outbound": false,
  "isRagEnabled": false,
  "isGuardianEnabled": true,
  "integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "internalName": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "companyName": "<string>",
    "industry": "DENTAL",
    "greeting": "<string>",
    "phoneGreeting": "<string>",
    "closedChatGreeting": "<string>",
    "closedPhoneGreeting": "<string>",
    "outbound": false,
    "isRagEnabled": false,
    "isGuardianEnabled": true,
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Body

Payload required to create a new bot

​
orgId
string<uuid>
required

The organization ID for the bot

​
name
string
required

The name of the bot

​
greeting
string
required

The greeting message for the bot

​
internalName
string

Internal name for the bot

​
companyName
string

The company name associated with the bot

​
industry
enum<string>
Available options:
DENTAL,
CHIROPRACTIC,
OPTOMETRY,
WELLNESS,
PEDIATRIC,
PEDIATRIC_DENTISTRY,
ORTHODONTIST,
SLEEP_MEDICINE,
BUSINESS_CONSULTANT,
MARKETING_COMPANY
​
phoneGreeting
string

The phone greeting message for the bot

​
closedChatGreeting
string

The closed chat greeting message

​
closedPhoneGreeting
string

The closed phone greeting message

​
outbound
boolean
default:false

Whether the bot is used to make outbound/recare calls

​
isRagEnabled
boolean
default:false
deprecated

DEPRECATED: This field is ignored. RAG is always disabled.

​
isGuardianEnabled
boolean
default:true
deprecated

DEPRECATED: This field is ignored. Guardian is always enabled.

​
integrationId
string<uuid>

The integration ID for the bot

Response

Response returned after creating a bot

​
success
enum<boolean>
required
Available options:
true
​
data
object
required

Represents a single Annie bot and its configuration