API Reference
Log in to see full request history
Query Params
string
required
Body Params
string
Defaults to AI + Human

This has to be either AI, AI + Human or Human

string

Timezone of the chatbot

string
Defaults to https://res.cloudinary.com/dnkz9luqz/image/upload/v1721280234/y5bbzujtx8wa2dwepkv9.svg

This will be the icon that will be shown on the chatbot

tabs_name
array of strings
Defaults to Home,Messages,Tickets,Help

This will be the name of the tabs that will be shown on the chatbot

Tabs Name
string
Defaults to Search for help
hero_title
array of strings
Defaults to Hey there 👋,How can we help?
Hero Title
string

This will be the logo image that will be shown on the chatbot

string
Defaults to #000000
boolean
Defaults to false

This will enable the voice note feature in the chatbot

boolean
Defaults to true
leads_field
array of objects
Defaults to [object Object],[object Object],[object Object]
Leads Field
boolean
Defaults to false

This will enable the feature to send images in the chatbot

integer
Defaults to 20
string
Defaults to #1219f3
string
string

This will be the display name of the chatbot

string
Defaults to #1219f3
hide_on_urls
array of strings
Defaults to

This will be the urls on which the chatbot will be hidden

Hide On Urls
boolean
Defaults to false

This will enable the feature to show message context sources in the chatbot

allow_on_urls
array of strings
Defaults to

This will be the urls on which the chatbot will be shown

Allow On Urls
boolean
Defaults to false

This will enable the audio message feature in the chatbot

integer
Defaults to 20

This will be the bottom margin of the chatbot

boolean
Defaults to true

This will enable the message sound feature in the chatbot

boolean
Defaults to true

This will show/hide the powered by text in the chatbot

boolean
Defaults to true

This will show/hide the feedback buttons in the chatbot

boolean
Defaults to true
auto_responder
array of strings
Defaults to Hi, we will soon connect you to a human agent. Please drop your query.

These messages will appear as standard responses from the chatbot when a user escaltes a conversation.

Auto Responder
string
Defaults to logo elephant.png
webhook_events
object
string
string
Defaults to https://elephant.ai/

This will be the link that will be opened when the powered by text is clicked

string
Defaults to Powered by Elephant.ai

This will be the text that will be shown in the powered by text

string
Defaults to https://res.cloudinary.com/dnkz9luqz/image/upload/v1721280234/y5bbzujtx8wa2dwepkv9.svg

This will be the profile picture that will be shown on the chatbot

string
Defaults to #ffffff
string
Defaults to #ffffff
string
Defaults to #1219f3
initial_messages
array of strings
Defaults to Hi, What can I help you with?

These messages will appear as standard responses from the chatbot when a conversation is started.

Initial Messages
boolean
Defaults to false
string
Defaults to Want to Make an Announcement? The Headline Goes Here.
string
Defaults to right

This will set the alignment of the chat bubble to right or left

string
Defaults to #ffffff
boolean
Defaults to false
string
Defaults to Are you sure you want to escalate the chat to human support?
string
Defaults to #1219f3
boolean
Defaults to false
boolean
Defaults to false
string
Defaults to Send us a message
suggested_messages
array of strings
Defaults to
Suggested Messages
string
Defaults to #1219f3
boolean
Defaults to true
string
Defaults to This conversation will be shared with the human support and they will get back to you as soon as they can.
string
Defaults to Send a message
boolean
Defaults to false
string
Defaults to https://res.cloudinary.com/dnkz9luqz/image/upload/v1721280234/y5bbzujtx8wa2dwepkv9.svg
string
Defaults to logo elephant.png
string
Defaults to Recent Message
boolean
Defaults to true
string
Defaults to #737373
string
Defaults to #e5eeff
string
Defaults to #F03D3D
string
Defaults to #02c502
string
Defaults to Start a Conversation
string
Defaults to #ffffff
boolean
Defaults to true
string
Defaults to We typically reply within a few minutes
string
Defaults to logo elephant.png
boolean
Defaults to true
boolean
Defaults to false
string
Defaults to 5
boolean
Defaults to true
boolean
Defaults to true
Headers
string
required
Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json