Get bot

Get bot

curl --request GET \
  --url https://api.helloannie.com/v1/bots/{id}

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Susan",
    "internalName": "general_practice_bot",
    "external_id": "practice_123_main_bot",
    "childBots": [
      "550e8400-e29b-41d4-a716-446655440001",
      "550e8400-e29b-41d4-a716-446655440002"
    ]
  }
}

GET

bots

{id}

Get bot

curl --request GET \
  --url https://api.helloannie.com/v1/bots/{id}

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Susan",
    "internalName": "general_practice_bot",
    "external_id": "practice_123_main_bot",
    "childBots": [
      "550e8400-e29b-41d4-a716-446655440001",
      "550e8400-e29b-41d4-a716-446655440002"
    ]
  }
}

Path Parameters

string<uuid>

required

Response

200 - application/json

data

object

Show child attributes

data.id

string<uuid>

Unique identifier for the bot

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.name

string

The bot's given name

Example:

"Susan"

data.internalName

string

Internal identifier to categorize the bot type

Example:

"general_practice_bot"

data.external_id

string | null

Optional external identifier from client's system

Example:

"practice_123_main_bot"

data.childBots

string<uuid>[]

Array of child bot IDs that this bot can delegate conversations to

Example:

[
  "550e8400-e29b-41d4-a716-446655440001",
  "550e8400-e29b-41d4-a716-446655440002"
]

Create bot Update bot

⌘I

Getting Started

Configuration

Training

Conversations

Path Parameters

Response