Alli Conversational AI
Alli AnswerBot allows you to build personalized user interaction, give your users full access to your knowledge base, and transform your team's operation efficiency across web and mobile.
Additional documentation can be found at: https://doc.alli.ai/
Start Conversation
POST
https://backend.alli.ai/webapi/start_conversation
Start a conversation using a Skill. Note: this endpoint is currently only compatible with Message Node, Q&A Node, and Documents Node.
Headers
API-KEY
string
Your API key can be found in your dashboard Settings menu, under the General tab.
OWN-USER-ID
string
The user id of the user who opens the conversation.
USER-EMAIL
string
Email address of the user who opens the conversation
Request Body
placement
string
Used to match which Skill to start the conversation with.
Request Example
Please replace YOUR_API_KEY with your one in the example below. To get the api key, please see getting-api-key section.
Response Example
Send Chat
POST
https://backend.alli.ai/webapi/send_chat
Send a message as the user for an existing conversation. Note: this endpoint is currently only compatible with Message Node, Q&A Node, and Documents Node.
Headers
API-KEY
string
Your API key can be found in your dashboard Settings menu, under the General tab.
Request Body
message
string
The message to send in the conversation. Cannot be null or an empty string.
conversationId
string
Unique id for the conversation you want to send a message in.
Request Example
Please replace YOUR_API_KEY with your one in the example below. To get the api key, please see getting-api-key section.
Response Example
Summary Analytics
GET
https://backend.alli.ai/webapi/summary_analytics
Provides various summarized analytics information for your project.
Headers
API-KEY
string
Your API key can be found in your dashboard Settings menu, under the General tab.
Request Body
startDate
string
Start of range of dates to query in YYYY-MM-DD format.
endDate
string
End of range of dates to query in YYYY-MM-DD format.
Request Example
Please replace YOUR_API_KEY with your one in the example below. To get the api key, please see getting-api-key section.
Response Example
Daily Conversation Count
GET
https://backend.alli.ai/webapi/conversation_daily_count
The total number of conversations per day for a given range.
Headers
API-KEY
string
Your API key can be found in your dashboard Settings menu, under the General tab.
Request Body
endDate
string
End of range of dates to query in YYYY-MM-DD format.
startDate
string
Start of range of dates to query in YYYY-MM-DD format.
Request Example
Please replace YOUR_API_KEY with your one in the example below. To get the api key, please see getting-api-key section.
Response Example
Daily FAQ Count
GET
https://backend.alli.ai/webapi/faq_daily_count
Daily trend of Q&A from FAQ in given date range.
Headers
API-KEY
string
Your API key can be found in your dashboard Settings menu, under the General tab.
Request Body
startDate
string
Start of range of dates to query in YYYY-MM-DD format.
endDate
string
End of range of dates to query in YYYY-MM-DD format.
Request Example
Please replace YOUR_API_KEY with your one in the example below. To get the api key, please see getting-api-key section.
Response Example
Daily FAQ Analytics
GET
https://backend.alli.ai/webapi/faq_daily_analytics
Analytics information for the most frequently asked Q&As.
Headers
API-KEY
string
Your API key can be found in your dashboard Settings menu, under the General tab.
Request Body
topN
number
Top N of the most frequently asked Q&A. Maximum value for N is 20. Please use 1, 5, 10, or 20 for N.
startDate
string
Start of range of dates to query in YYYY-MM-DD format.
endDate
string
End of range of dates to query in YYYY-MM-DD format.
Request Example
Please replace YOUR_API_KEY with your one in the example below. To get the api key, please see getting-api-key section.
Response Example
Executing a Skill
POST
https://backend.alli.ai/webapi/skill
This API executes a skill and returns the final text answer as json format. Please follow the link under the 'Learn More about Variables' below for more information about the variables parameter. This API can be used for the entity extraction if the skill is designed for the entity extraction.
Headers
API-KEY
string
Your API KEY can be found in your Dashboard Settings menu under the general tab
Request Body
id
string
This is a skill id. If you click a skill in the Alli Dashboard, the URL is something like https://app.alli.ai/projects/PROJECT_ID/campaigns/SKILL_ID. Please put SKILL_ID here.
text
string
This is an input text for the skill execution.
variables
object
variables is a JSON object to set the variables in the skill.
Learn More about Variables
To learn more about the variables in Alli, please see this user guide.
Request Example
Please replace YOUR_API_KEY with your one in the example below. To get the api key, please see getting-api-key section.
Response Example
Last updated
Was this helpful?