Form-Chat

Parameters

Parameter

Required

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.

<?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>

Form-Check-Instance

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

Parameters

Parameter

Required

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.

<?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>

<?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>

Chat

Parameters

Parameter

Required

Attribute

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.

<?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>

Check-Instance

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

Parameters

Parameter

Required

Attribute

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.

ઉદાહરણ

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

ઉદાહરણ પરિણામ

<?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>

Get-All-Instances

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

Parameters

Parameter

Required

Attribute

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.

ઉદાહરણ

<browse application="1234567890"/>

ઉદાહરણ પરિણામ

<?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>