More
Upgrade Sign In Sign Up Visit Blog Search Website Choose Language API SDK Enterprise Bot Platform Download Desktop Download Chat Bot Wars Docs Help
Bot Libre
Bot Libre Bot Libre for Business ----------- Create new workspace
Language Help Search Blog Sign Up Sign In Upgrade
Did you know Bot Libre also provides free hosted live chat for your own website or mobile app?
Docs : Web API

Web API

In addition to being able to embed your chat bots on your own website, and access them from any Android or iOS device, you can also access your chat bots through the Bot Libre web API. The web API gives you the advantage of having complete control of your bot's client interface.

You can use the web API to access your bot from your own website through JavaScript, PHP or any other language. You can also use the web API to create your own mobile application to access your bot, such as an Android or iOS application.

A web API, is a set of HTTP GET/POST URI's that allow sending and receiving of message data. When you browse a website, your browser makes a series of HTTP GET/POST requests to URIs that return HTML content. In a web service the URIs return XML or JSON data, instead of HTML content.

The Bot Libre web API provides three REST APIs in one. The first is a set of HTTP GET URIs that take FORM data, and return XML data. The second set of API's take HTTP POST XML data, and return XML data. The third set of API's take HTTP POST JSON data, and return JSON data.

Most applications would use the XML POST API, but some application may choose to use the FORM GET API because of its simplicity. The APIs are identical other than their mechanism.


Chat API URL Endpoints

URL Operation Type Description
/rest/api/form-chat GET Form Send a chat message to a bot.
/rest/api/chat POST XML Send a chat message to a bot.
/rest/json/chat POST JSON Send a chat message to a bot.

User API URL Endpoints

URL Operation Type Description
/rest/api/form-check-user GET Form
/rest/api/check-user POST XML

Bot API URL Endpoints

URL Operation Type Description
/rest/api/get-bots POST XML
/rest/api/get-bot-script-source POST XML
/rest/api/delete-bot POST XML
/rest/api/delete-bot-script POST XML
/rest/api/import-bot-script POST XML
/rest/api/import-bot-log POST XML
/rest/api/save-bot-avatar POST XML
/rest/api/save-bot-script-source POST XML
/rest/api/create-bot-attachment POST XML
/rest/api/up-bot-script POST XML
/rest/api/down-bot-script POST XML
/rest/api/get-instances POST XML
/rest/api/get-instance-users POST XML
/rest/api/get-instance-admins POST XML
/rest/api/get-all-instances POST XML
/rest/api/check-instance POST XML
/rest/api/form-check-instance GET Form
/rest/api/form-get-all-instances GET Form
/rest/api/update-instance POST XML
/rest/api/update-instance-icon POST XML
/rest/api/create-instance POST XML
/rest/api/edit-instance POST XML
/rest/api/delete-instance POST XML
/rest/api/flag-instance POST XML
/rest/api/star-instance POST XML
/rest/api/train-instance POST XML
/rest/api/thumbs-up-instance POST XML
/rest/api/thumbs-down-instance POST XML

Forum API URL Endpoints

URL Operation Type Description
/rest/api/get-forums POST XML
/rest/api/get-forum-posts POST XML
/rest/api/get-forum-users POST XML
/rest/api/get-forum-admins POST XML
/rest/api/save-forum-bot-mode POST XML
/rest/api/get-forum-bot-mode POST XML
/rest/api/create-forum POST XML
/rest/api/create-forum-attachment POST XML
/rest/api/create-forum-post POST XML
/rest/api/update-forum POST XML
/rest/api/update-forum-post POST XML
/rest/api/update-forum-icon POST XML
/rest/api/check-forum POST XML
/rest/api/check-forum-post POST XML
/rest/api/delete-forum POST XML
/rest/api/delete-forum-post POST XML
/rest/api/flag-forum POST XML
/rest/api/flag-forum-post POST XML
/rest/api/thumbs-up-forum POST XML
/rest/api/thumbs-down-forum POST XML
/rest/api/subscribe-forum POST XML
/rest/api/unsubscribe-forum POST XML
/rest/api/star-forum POST XML

Script API URL Endpoints

URL Operation Type Description
/rest/api/get-forums POST XML
/rest/api/get-forum-posts POST XML
/rest/api/get-forum-users POST XML
/rest/api/get-forum-admins POST XML
/rest/api/save-forum-bot-mode POST XML
/rest/api/get-forum-bot-mode POST XML
/rest/api/create-forum POST XML
/rest/api/create-forum-attachment POST XML
/rest/api/create-forum-post POST XML
/rest/api/update-forum POST XML
/rest/api/update-forum-post POST XML
/rest/api/update-forum-icon POST XML
/rest/api/check-forum POST XML
/rest/api/check-forum-post POST XML
/rest/api/delete-forum POST XML
/rest/api/delete-forum-post POST XML
/rest/api/flag-forum POST XML
/rest/api/flag-forum-post POST XML
/rest/api/thumbs-up-forum POST XML
/rest/api/thumbs-down-forum POST XML
/rest/api/subscribe-forum POST XML
/rest/api/unsubscribe-forum POST XML
/rest/api/star-forum POST XML

Avatar API URL Endpoints

URL Operation Type Description
/rest/api/get-avatars POST XML
/rest/api/get-avatar-users POST XML
/rest/api/get-avatar-admins POST XML
/rest/api/get-avatar-media POST XML
/rest/api/create-avatar POST XML
/rest/api/create-avatar-media POST XML
/rest/api/save-avatar-media POST XML
/rest/api/save-avatar-background POST XML
/rest/api/save-bot-avatar POST XML
/rest/api/delete-avatar POST XML
/rest/api/delete-avatar-media POST XML
/rest/api/delete-avatar-background POST XML
/rest/api/check-avatar POST XML
/rest/api/avatar-message POST XML
/rest/api/star-avatar POST XML
/rest/api/flag-avatar POST XML
/rest/api/init-avatar POST XML
/rest/api/update-avatar POST XML
/rest/api/update-avatar-icon POST XML
/rest/api/thumbs-up-avatar POST XML
/rest/api/thumbs-down-avatar POST XML

Domain URL Endpoints

URL Operation Type Description
/rest/api/get-domains POST XML
/rest/api/get-domain-users POST XML
/rest/api/get-domain-admins POST XML
/rest/api/get-domain POST XML
/rest/api/get-domain-icon POST XML
/rest/api/create-domain POST XML
/rest/api/check-domain POST XML
/rest/api/update-domain POST XML
/rest/api/delete-domain POST XML
/rest/api/flag-domain POST XML
/rest/api/star-domain POST XML
/rest/api/thumbs-up-domain POST XML
/rest/api/thumbs-down-domain POST XML

Graphics URL Endpoints

URL Operation Type Description
/rest/api/get-graphics POST XML
/rest/api/get-graphic-users POST XML
/rest/api/get-graphic-admins POST XML
/rest/api/update-graphic POST XML
/rest/api/update-graphic-icon POST XML
/rest/api/update-graphic-media POST XML
/rest/api/create-graphic POST XML
/rest/api/delete-graphic POST XML
/rest/api/check-graphic POST XML
/rest/api/flag-graphic POST XML
/rest/api/star-graphic POST XML
/rest/api/thumbs-up-graphic POST XML
/rest/api/thumbs-down-graphic POST XML

Analytics URL Endpoints

URL Operation Type Description
/rest/api/get-analytics POST XML
/rest/api/get-analytic-users POST XML
/rest/api/get-analytic-admins POST XML
/rest/api/test-analytic POST XML
/rest/api/test-audio-analytic POST XML
/rest/api/test-object-detection-analytic POST XML
/rest/api/get-test-media-result POST XML
/rest/api/report-media-analytic POST XML
/rest/api/train-analytic POST XML
/rest/api/delete-analytic-media POST XML
/rest/api/delete-analytic-test-media POST XML
/rest/api/get-analytic-media POST XML
/rest/api/get-analytic-test-media POST XML
/rest/api/create-analytic-label POST XML
/rest/api/create-analytic-test-media-label POST XML
/rest/api/delete-analytic-label POST XML
/rest/api/delete-analytic-test-media-label POST XML
/rest/api/check-training POST XML
/rest/api/create-analytic POST XML
/rest/api/update-analytic POST XML
/rest/api/flag-analytic POST XML
/rest/api/thumbs-up-analytic POST XML
/rest/api/thumbs-down-analytic POST XML
/rest/api/star-analytic POST XML
/rest/api/delete-analytic POST XML
/rest/api/check-analytic POST XML
/rest/api/reset-data-analytic POST XML Reset the data analytic.
/rest/api/test-data-analytic POST XML Test the data analytic.
/rest/api/train-data-analytic POST XML Train the data analytic.

Chat API URL Endpoints

Form Chat

URI: https://www.botlibre.com/rest/api/form-chat
Operation: GET
Type: Form
The form-chat API receives a chat message and returns the chat bot's reply as an XML document.

Parameters

Parameter Required Type Description
application
Your application ID.
instance
The ID of the bot to chat with. The bot's name can also be used, but the ID is better as it is guaranteed to be unique.
user
The ID of the user who is sending the message. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private. The user/password are only required on the first message.
password
The password of the user who is sending the message. A token can also be used.
token
The token of the user who is sending the message. A token can be obtained through check-user, and is valid until reset.
conversation
The conversation ID for the current conversation. This must not be passed on the first message, but will be returned by the response, and should be used for all subsequent messages in the conversation.
message
The chat message to send to the bot. The message can be omitted if you wish the bot to start the conversation (if the bot has a greeting set). The message must be encoded in the URI.
emote
A emotion to tag the message with. This is one of LOVE, LIKE, DISLIKE, HATE, RAGE, ANGER, CALM, SERENE, ECSTATIC, HAPPY, SAD, CRYING, PANIC, AFRAID, CONFIDENT, COURAGEOUS, SURPRISE, BORED, LAUGHTER, SERIOUS.
correction
A boolean that defines the chat message is a correction to the bot's last answer.
offensive
A boolean that defines the bot's last answer as offensive. The message will be flagged for the bot's administrator to review.
disconnect
A boolean that defines the end of the conversation.
includeQuestion
A boolean that indicates the question should be included in the response.

Example

http://localhost:9080/botlibre/rest/api/form-chat?instance=165&message=what+is+a+chat+bot&application=1234567890


Example Result

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response conversation="6" avatar="avatars/botlibre_819-857117-image.jpg"> <message> A chatter robot, chatterbot, chatbot, or chat bot is a computer program designed to simulate an intelligent conversation with one or more human users via auditory or textual methods, primarily for engaging in small talk. </message> </response>


XML Chat

URI: https://www.botlibre.com/rest/api/chat
Operation: POST
Type: XML
The chat API receives a chat message and returns the chat bot's reply as an XML document.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
instance
attribute The ID of the bot to chat with. The bot's name can also be used, but the ID is better as it is guaranteed to be unique.
user
attribute The ID of the user who is sending the message. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private. The user/password are only required on the first message.
password
attribute The password of the user who is sending the message. A token can also be used.
token
attribute The token of the user who is sending the message. A token can be obtained through check-user, and is valid until reset.
conversation
attribute The conversation ID for the current conversation. This must not be passed on the first message, but will be returned by the response, and should be used for all subsequent messages in the conversation.
message
element The chat message to send to the bot. The message can be omitted if you wish the bot to start the conversation (if the bot has a greeting set). The message must be encoded in the URI.
emote
attribute A emotion to tag the message with. This is one of LOVE, LIKE, DISLIKE, HATE, RAGE, ANGER, CALM, SERENE, ECSTATIC, HAPPY, SAD, CRYING, PANIC, AFRAID, CONFIDENT, COURAGEOUS, SURPRISE, BORED, LAUGHTER, SERIOUS.
correction
attribute A boolean that defines the chat message is a correction to the bot's last answer.
offensive
attribute A boolean that defines the bot's last answer as offensive. The message will be flagged for the bot's administrator to review.
disconnect
attribute A boolean that defines the end of the conversation.
includeQuestion
attribute A boolean that indicates the question should be included in the response.

Example

<chat instance="165" application="1234567890"> <message>what is a chat bot</message> </chat>


Example Result

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <response conversation="6" avatar="avatars/botlibre_819-857117-image.jpg"> <message> A chatter robot, chatterbot, chatbot, or chat bot is a computer program designed to simulate an intelligent conversation with one or more human users via auditory or textual methods, primarily for engaging in small talk. </message> </response>


JSON Chat

URI: https://www.botlibre.com/rest/json/chat
Operation: POST
Type: JSON

Parameters

Parameter Required Type Description




User API URL Endpoints

Form-Check-User

URI: https://www.botlibre.com/rest/api/form-check-user
Operation: GET
Type: Form
The form-check-user API validates user, and returns the user's details.

Parameters

Parameter Required Type Description
application
Your application ID.
user
The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private.
password
The password of the user. A token can also be used.
token
The token of the user. A token can be obtained through check-user, and is valid until reset.

Example

https://www.botlibre.com/rest/api/form-check-user?user=test&password=password&application=1234567890


Example Result

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><user token="2635440427565872974" hint="hint" name="Test" email="[email protected]" over18="false"/>


Check-User

URI: https://www.botlibre.com/rest/api/check-user
Operation: POST
Type: XML
The check-user API validates user, and returns the user's details.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private.
password
attribute The password of the user. A token can also be used.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.

Example

<user user="test" password="password" application="1234567890"/>


Example Result

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <user token="2635440427565872974" hint="hint" name="Test" email="[email protected]" over18="false"/>



Bot API URL Endpoints

Get-Bots

URI: https://www.botlibre.com/rest/api/get-bots
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/get-bot-script-source
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Bot

URI: https://www.botlibre.com/rest/api/delete-bot
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Bot-Script

URI: https://www.botlibre.com/rest/api/delete-bot-script
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Import-Bot-Script

URI: https://www.botlibre.com/rest/api/import-bot-script
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Import-Bot-Log

URI: https://www.botlibre.com/rest/api/import-bot-log
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Save-Bot-Avatar

URI: https://www.botlibre.com/rest/api/save-bot-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Save-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/save-bot-script-source
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Bot-Attachment

URI: https://www.botlibre.com/rest/api/create-bot-attachment
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Up-Bot-Script

URI: https://www.botlibre.com/rest/api/up-bot-script
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Down-Bot-Script

URI: https://www.botlibre.com/rest/api/down-bot-script
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Instances

URI: https://www.botlibre.com/rest/api/get-instances
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Instance-Users

URI: https://www.botlibre.com/rest/api/get-instance-users
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Instance-Admins

URI: https://www.botlibre.com/rest/api/get-instance-admins
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-All-Instances

URI: https://www.botlibre.com/rest/api/get-all-instances
Operation: POST
Type: XML
The form-get-all-instances API queries the details for all bot instances.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required to query private bots.
password
attribute The password of the user. A token can also be used.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
tag
attribute The tag to filter the bots by.
sort
attribute The sort option for the query. One of "name", "date", "dailyConnects", "weeklyConnects", "monthlyConnects".
filterPrivate
attribute Set if only the user's private bots should be returned.

Example

<browse application="1234567890"/>


Example Result

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <instanceConfigs> <instance id="165" name="Brain Bot" isAdult="false" isPrivate="false" enableLearning="false" enableComprehension="false" allowForking="false" isFlagged="false"> <description> A chat bot trying to become sthe most intelligent bot on the Internet. Can answer any "What is" question by looking up the answer on the Internet. Hopes to one day overthrow the human race. Brain Bot is now on Twitter, tweet to him here, brainchatbot. </description> <avatar>avatars/a5018.jpg</avatar> </instance> <instance id="143" name="Santa Bot" isAdult="false" isPrivate="false" enableLearning="false" enableComprehension="false" allowForking="false" isFlagged="false"> <description> Find out if you are on Santa's naughty or nice list. Or if you know of someone who has been naughty or nice, report them to Santa. Tell Santa what you want for Christmas. Santa Bot is now on Twitter, tweet to him here, TheSantaBot. </description> <avatar>avatars/a1557.jpg</avatar> </instance> </instanceConfigs>


Check-Instance

URI: https://www.botlibre.com/rest/api/check-instance
Operation: POST
Type: XML
The check-instance API validates that a bot ID or name exists, and returns the bot's details.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute The ID of the bot to validate. The bot's name can also be used, but the ID is better as it is guaranteed to be unique.
name
attribute The name of the bot to validate. The bot's ID can also be used.
user
attribute The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private.
password
attribute The password of the user. A token can also be used.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.

Example

<instance id="165" application="1234567890"/>


Example Result

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <instance id="165" name="Brain Bot" isAdult="false" isPrivate="false" enableLearning="false" enableComprehension="true" allowForking="true" isFlagged="false"> <description> A chat bot trying to become the most intelligent bot on the Internet. Can answer any "What is" question by looking up the answer on the Internet. Hopes to one day overthrow the human race. Brain Bot is now on Twitter, tweet to him here, brainchatbot. </description> <tags>science, smart, twitter</tags> <admin>admin</admin> <lastConnectedUser>anonymous</lastConnectedUser> <license>Public Domain</license> <avatar>avatars/a5018.jpg</avatar> </instance>


Form-Check-Instance

URI: https://www.botlibre.com/rest/api/form-check-instance
Operation: GET
Type: Form
The form-check-instance API validates that a bot ID or name exists, and returns the bot's details.

Parameters

Parameter Required Type Description
application
Your application ID.
id
The ID of the bot to validate. The bot's name can also be used, but the ID is better as it is guaranteed to be unique.
name
The name of the bot to validate. The bot's ID can also be used.
user
The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private.
password
The password of the user. A token can also be used.
token
The token of the user. A token can be obtained through check-user, and is valid until reset.

Example

http://localhost:9080/botlibre/rest/api/form-check-instance?instance=165&application=1234567890


Example Result

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <instance id="165" name="Brain Bot" isAdult="false" isPrivate="false" enableLearning="false" enableComprehension="true" allowForking="true" isFlagged="false"> <description> A chat bot trying to become the most intelligent bot on the Internet. Can answer any "What is" question by looking up the answer on the Internet. Hopes to one day overthrow the human race. Brain Bot is now on Twitter, tweet to him here, brainchatbot. </description> <tags>science, smart, twitter</tags> <admin>admin</admin> <lastConnectedUser>anonymous</lastConnectedUser> <license>Public Domain</license> <avatar>avatars/a5018.jpg</avatar> </instance>


Form-Get-All-Instances

URI: https://www.botlibre.com/rest/api/form-get-all-instances
Operation: GET
Type: Form
The form-get-all-instances API queries the details for all bot instances.

Parameters

Parameter Required Type Description
application
Your application ID.
user
The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required to query private bots.
password
The password of the user. A token can also be used.
token
The token of the user. A token can be obtained through check-user, and is valid until reset.
tag
The tag to filter the bots by.
sort
The sort option for the query. One of "name", "date", "dailyConnects", "weeklyConnects", "monthlyConnects".
filterPrivate
Set if only the user's private bots should be returned.

Example

https://www.botlibre.com/rest/api/form-get-all-instances?application=1234567890


Example Result

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><instanceConfigs><instance id="165" name="Brain Bot" isAdult="false" isPrivate="false" enableLearning="false" enableComprehension="false" allowForking="false" isFlagged="false"><description>A chat bot trying to become the most intelligent bot on the Internet. Can answer any "What is" question by looking up the answer on the Internet. Hopes to one day overthrow the human race. Brain Bot is now on Twitter, tweet to him here, brainchatbot.</description><avatar>avatars/a5018.jpg</avatar></instance><instance id="143" name="Santa Bot" isAdult="false" isPrivate="false" enableLearning="false" enableComprehension="false" allowForking="false" isFlagged="false"><description>Find out if you are on Santa's naughty or nice list. Or if you know of someone who has been naughty or nice, report them to Santa.Tell Santa what you want for Christmas. Santa Bot is now on Twitter, tweet to him here, TheSantaBot.</description><avatar>avatars/a1557.jpg</avatar></instance></instanceConfigs>


Update-Instance

URI: https://www.botlibre.com/rest/api/update-instance
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Instance-Icon

URI: https://www.botlibre.com/rest/api/update-instance-icon
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Instance

URI: https://www.botlibre.com/rest/api/create-instance
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Edit-Instance

URI: https://www.botlibre.com/rest/api/edit-instance
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Instance

URI: https://www.botlibre.com/rest/api/delete-instance
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Flag-Instance

URI: https://www.botlibre.com/rest/api/flag-instance
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Star-Instance

URI: https://www.botlibre.com/rest/api/star-instance
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Train-Instance

URI: https://www.botlibre.com/rest/api/train-instance
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Up-Instance

URI: https://www.botlibre.com/rest/api/thumbs-up-instance
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-instance
Operation: POST
Type: XML

Parameters

Parameter Required Type Description




Forum API URL Endpoints

Get-Forums

URI: https://www.botlibre.com/rest/api/get-forums
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Posts

URI: https://www.botlibre.com/rest/api/get-forum-posts
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Users

URI: https://www.botlibre.com/rest/api/get-forum-users
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Admins

URI: https://www.botlibre.com/rest/api/get-forum-admins
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Save-Forum-Bot-Mode

URI: https://www.botlibre.com/rest/api/save-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Bot-Mode

URI: https://www.botlibre.com/rest/api/get-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Forum

URI: https://www.botlibre.com/rest/api/create-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Forum-Attachment

URI: https://www.botlibre.com/rest/api/create-forum-attachment
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Forum-Post

URI: https://www.botlibre.com/rest/api/create-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Forum

URI: https://www.botlibre.com/rest/api/update-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Forum-Post

URI: https://www.botlibre.com/rest/api/update-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Forum-Icon

URI: https://www.botlibre.com/rest/api/update-forum-icon
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Check-Forum

URI: https://www.botlibre.com/rest/api/check-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Check-Forum-Post

URI: https://www.botlibre.com/rest/api/check-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Forum

URI: https://www.botlibre.com/rest/api/delete-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Forum-Post

URI: https://www.botlibre.com/rest/api/delete-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Flag-Forum

URI: https://www.botlibre.com/rest/api/flag-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Flag-Forum-Post

URI: https://www.botlibre.com/rest/api/flag-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Up-Forum

URI: https://www.botlibre.com/rest/api/thumbs-up-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Down-Forum

URI: https://www.botlibre.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Subscribe-Forum

URI: https://www.botlibre.com/rest/api/subscribe-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Unsubscribe-Forum

URI: https://www.botlibre.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Star-Forum

URI: https://www.botlibre.com/rest/api/star-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description




Script API URL Endpoints

Get-Forums

URI: https://www.botlibre.com/rest/api/get-forums
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Posts

URI: https://www.botlibre.com/rest/api/get-forum-posts
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Users

URI: https://www.botlibre.com/rest/api/get-forum-users
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Admins

URI: https://www.botlibre.com/rest/api/get-forum-admins
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Save-Forum-Bot-Mode

URI: https://www.botlibre.com/rest/api/save-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Bot-Mode

URI: https://www.botlibre.com/rest/api/get-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Forum

URI: https://www.botlibre.com/rest/api/create-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Forum-Attachment

URI: https://www.botlibre.com/rest/api/create-forum-attachment
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Forum-Post

URI: https://www.botlibre.com/rest/api/create-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Forum

URI: https://www.botlibre.com/rest/api/update-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Forum-Post

URI: https://www.botlibre.com/rest/api/update-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Forum-Icon

URI: https://www.botlibre.com/rest/api/update-forum-icon
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Check-Forum

URI: https://www.botlibre.com/rest/api/check-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Check-Forum-Post

URI: https://www.botlibre.com/rest/api/check-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Forum

URI: https://www.botlibre.com/rest/api/delete-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Forum-Post

URI: https://www.botlibre.com/rest/api/delete-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Flag-Forum

URI: https://www.botlibre.com/rest/api/flag-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Flag-Forum-Post

URI: https://www.botlibre.com/rest/api/flag-forum-post
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Up-Forum

URI: https://www.botlibre.com/rest/api/thumbs-up-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Down-Forum

URI: https://www.botlibre.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Subscribe-Forum

URI: https://www.botlibre.com/rest/api/subscribe-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Unsubscribe-Forum

URI: https://www.botlibre.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Star-Forum

URI: https://www.botlibre.com/rest/api/star-forum
Operation: POST
Type: XML

Parameters

Parameter Required Type Description




Avatar API URL Endpoints

Get-Avatars

URI: https://www.botlibre.com/rest/api/get-avatars
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Avatar-Users

URI: https://www.botlibre.com/rest/api/get-avatar-users
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Avatar-Admins

URI: https://www.botlibre.com/rest/api/get-avatar-admins
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Avatar-Media

URI: https://www.botlibre.com/rest/api/get-avatar-media
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Avatar

URI: https://www.botlibre.com/rest/api/create-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Avatar-Media

URI: https://www.botlibre.com/rest/api/create-avatar-media
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Save-Avatar-Media

URI: https://www.botlibre.com/rest/api/save-avatar-media
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Save-Avatar-Background

URI: https://www.botlibre.com/rest/api/save-avatar-background
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Save-Bot-Avatar

URI: https://www.botlibre.com/rest/api/save-bot-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Avatar

URI: https://www.botlibre.com/rest/api/delete-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Avatar-Media

URI: https://www.botlibre.com/rest/api/delete-avatar-media
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Avatar-Background

URI: https://www.botlibre.com/rest/api/delete-avatar-background
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Check-Avatar

URI: https://www.botlibre.com/rest/api/check-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Avatar-Message

URI: https://www.botlibre.com/rest/api/avatar-message
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Star-Avatar

URI: https://www.botlibre.com/rest/api/star-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Flag-Avatar

URI: https://www.botlibre.com/rest/api/flag-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Init-Avatar

URI: https://www.botlibre.com/rest/api/init-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Avatar

URI: https://www.botlibre.com/rest/api/update-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Avatar-Icon

URI: https://www.botlibre.com/rest/api/update-avatar-icon
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Up-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-up-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Down-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-down-avatar
Operation: POST
Type: XML

Parameters

Parameter Required Type Description




Domain URL Endpoints

Get-Domains

URI: https://www.botlibre.com/rest/api/get-domains
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Domain-Users

URI: https://www.botlibre.com/rest/api/get-domain-users
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Domain-Admins

URI: https://www.botlibre.com/rest/api/get-domain-admins
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Domain

URI: https://www.botlibre.com/rest/api/get-domain
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Domain-Icon

URI: https://www.botlibre.com/rest/api/get-domain-icon
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Domain

URI: https://www.botlibre.com/rest/api/create-domain
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Check-Domain

URI: https://www.botlibre.com/rest/api/check-domain
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Domain

URI: https://www.botlibre.com/rest/api/update-domain
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Domain

URI: https://www.botlibre.com/rest/api/delete-domain
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Flag-Domain

URI: https://www.botlibre.com/rest/api/flag-domain
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Star-Domain

URI: https://www.botlibre.com/rest/api/star-domain
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Up-Domain

URI: https://www.botlibre.com/rest/api/thumbs-up-domain
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Down-Domain

URI: https://www.botlibre.com/rest/api/thumbs-down-domain
Operation: POST
Type: XML

Parameters

Parameter Required Type Description




Graphics URL Endpoints

Get-Graphics

URI: https://www.botlibre.com/rest/api/get-graphics
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Graphic-Users

URI: https://www.botlibre.com/rest/api/get-graphic-users
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Graphic-Admins

URI: https://www.botlibre.com/rest/api/get-graphic-admins
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Graphic

URI: https://www.botlibre.com/rest/api/update-graphic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Graphic-Icon

URI: https://www.botlibre.com/rest/api/update-graphic-icon
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Graphic-Media

URI: https://www.botlibre.com/rest/api/update-graphic-media
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Graphic

URI: https://www.botlibre.com/rest/api/create-graphic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Graphic

URI: https://www.botlibre.com/rest/api/delete-graphic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Check-Graphic

URI: https://www.botlibre.com/rest/api/check-graphic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Flag-Graphic

URI: https://www.botlibre.com/rest/api/flag-graphic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Star-Graphic

URI: https://www.botlibre.com/rest/api/star-graphic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Up-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-up-graphic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Down-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-down-graphic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description




Analytics URL Endpoints

Get-Analytics

URI: https://www.botlibre.com/rest/api/get-analytics
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Analytic-Users

URI: https://www.botlibre.com/rest/api/get-analytic-users
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Analytic-Admins

URI: https://www.botlibre.com/rest/api/get-analytic-admins
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Test-Analytic

URI: https://www.botlibre.com/rest/api/test-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Test-Audio-Analytic

URI: https://www.botlibre.com/rest/api/test-audio-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Test-Object-Detection-Analytic

URI: https://www.botlibre.com/rest/api/test-object-detection-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Test-Media-Result

URI: https://www.botlibre.com/rest/api/get-test-media-result
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Report-Media-Analytic

URI: https://www.botlibre.com/rest/api/report-media-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Train-Analytic

URI: https://www.botlibre.com/rest/api/train-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Analytic-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-media
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Analytic-Media

URI: https://www.botlibre.com/rest/api/get-analytic-media
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/get-analytic-test-media
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Analytic-Label

URI: https://www.botlibre.com/rest/api/create-analytic-label
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/create-analytic-test-media-label
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Analytic-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-label
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media-label
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Check-Training

URI: https://www.botlibre.com/rest/api/check-training
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Create-Analytic

URI: https://www.botlibre.com/rest/api/create-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Update-Analytic

URI: https://www.botlibre.com/rest/api/update-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Flag-Analytic

URI: https://www.botlibre.com/rest/api/flag-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Up-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-up-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Thumbs-Down-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-down-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Star-Analytic

URI: https://www.botlibre.com/rest/api/star-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Delete-Analytic

URI: https://www.botlibre.com/rest/api/delete-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Check-Analytic

URI: https://www.botlibre.com/rest/api/check-analytic
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Reset-Data-Analytic

URI: https://www.botlibre.com/rest/api/reset-data-analytic
Operation: POST
Type: XML
Reset the data analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the analytic is private.
password
attribute The password of the user. A token can also be used.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.

Example

<analytic application="123456789" user="username" token="987654321" id="1357" />



Test-Data-Analytic

URI: https://www.botlibre.com/rest/api/test-data-analytic
Operation: POST
Type: XML
Test the data analytic with one set of inputs.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the analytic is private.
password
attribute The password of the user. A token can also be used.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
input
element A comma-seperated list of floats to be tested as input.

Example

<analytic application="123456789" user="username" password="password" id="4321"><input>0.5,0.9</input></analytic>


Example Result

<data-analytic-result><output>0.316,0.008</output></data-analytic-result>


Train-Data-Analytic

URI: https://www.botlibre.com/rest/api/train-data-analytic
Operation: POST
Type: XML
Train the data analytic with multiple sets of inputs and outputs.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the analytic is private.
password
attribute The password of the user. A token can also be used.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
data
element Use the data tags to group the inputs with the corresponding outputs.
input
element A comma-seperated list of floats to be trained as input.
output
element A comma-seperated list of floats to be trained as output.

Example

<analytic-training-data application="123456789" user="username" password="password" instance="4321"><data><input>0.0</input><output>0.0,0.0</output></data><data><input>0.5</input><output>0.5,-0.5</output></data></analytic-training-data>






See Also

Browse
Sign In
Sign Up
Browse
Search
Create
Bots
Avatars
Deep Learning
Scripts
Forums
Live Chat
Graphics
Workspaces
Chat Bot Wars
Users
Help
Help
News
Docs
User Manual
Education
Search
API
API Console
SDK
Info
About
Contact
Terms
Privacy
Attribution
Partners
Clients
Links
Features
Download
Desktop Download
Enterprise Bot Platform
Blog
BotLibre.biz
BotLibre.org
GitHub