The chatbot APIS are used to create and maintain chatbots. Characteristically a chatbot can be made Public or Private by setting its “publicbot” field to “true”. If Its value is “false” only the registered users of the chatbot can chat with the chatbot.
A chatbot can also be an administrative chatbot. An administrative chatbot can create other chatbots, while a non-administrative chatbot cannot. An administrative chatbot is a chatbot whose "isAdminModule" field is set to “true”. If it is set to “false” the chatbot cannot create or administrate other chatbots.
If a chatbot is an administrative chatbot we say it is a Master chatbot. When creating other chatbots using the Register Chatbot API you must always supply the chatbotMaster field value. This value is the chatbotKey value of the Master Chatbot.
The following APIS are used to create and manage chatbots:
- Register Chatbot API. This API is used to register or create a chatbot for the first time.
- Update chatbot API. This API is used to update the fields of a chatbot.
- Delete Chatbot API. This API will delete a chatbot based on its chatbot key value.
- Query Chatbot API. This API will query one chatbot and will return all the values of the fields of the chatbot.
- Query all Chatbots API. This API will query all chatbots for a particular master chatbot and deliver them in a list of chatbots. It will return all field values for for each chatbot.
- Chatbot add documents API. This API is used to train the chatbot with new documents by supplying a list of documents and a list of sources.
The apis are all of the POST type and uses a JSON body. To subscribe to the APIS please visit the GWOCU website.