More
Virtual Dream Chat
Language Help Search Sign Up Sign In Upgrade

This website and apps are for sale. Only serious offers will be considered. Contact [email protected]

Docs : Web API

Web API

Virtual Dream Chat is based on the open source Bot Libre platform.

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 Validates and returns the user's details.
/rest/api/check-user POST XML Validates and returns the user's details.

Bot API URL Endpoints

URL Operation Type Description
/rest/api/get-bots POST XML Returns all bots.
/rest/api/get-bot-script-source POST XML Get the source of the script.
/rest/api/delete-bot POST XML Deleting a selected bot.
/rest/api/delete-bot-script POST XML Delete a script from a bot.
/rest/api/import-bot-script POST XML Import a script bot.
/rest/api/import-bot-log POST XML Import a log of a bot.
/rest/api/save-bot-avatar POST XML Choose an avatar and save for a bot.
/rest/api/save-bot-script-source POST XML
/rest/api/create-bot-attachment POST XML
/rest/api/up-bot-script POST XML Move up the bot script
/rest/api/down-bot-script POST XML Move down the bot script.
/rest/api/get-instances POST XML Get all instances.
/rest/api/get-instance-users POST XML Get instance users.
/rest/api/get-instance-admins POST XML Get instance admins.
/rest/api/get-all-instances POST XML Queries the details for all bot instances.
/rest/api/check-instance POST XML Validates a bot ID or name exists, and returns the details.
/rest/api/form-check-instance GET Form Validates Bot ID, and returns the bot's details.
/rest/api/form-get-all-instances GET Form Queries the details for all bot instances.
/rest/api/update-instance POST XML Update contents of bot instance.
/rest/api/update-instance-icon POST XML Update to change the bot instance icon.
/rest/api/create-instance POST XML Create a new bot instance
/rest/api/edit-instance POST XML Edit bot instance.
/rest/api/delete-instance POST XML Delete current bot instance.
/rest/api/flag-instance POST XML Flag a bot instance.
/rest/api/star-instance POST XML Star a bot instance.
/rest/api/train-instance POST XML Train a chat bot instance.
/rest/api/thumbs-up-instance POST XML Thumbs up a chat bot instance.
/rest/api/thumbs-down-instance POST XML Thumbs down a chat bot instance

Forum API URL Endpoints

URL Operation Type Description
/rest/api/get-forums POST XML Retrieve the forums.
/rest/api/get-forum-posts POST XML Retrieve the posts of a forum.
/rest/api/get-forum-users POST XML Get users of a forum.
/rest/api/get-forum-admins POST XML Get admins of a forum.
/rest/api/save-forum-bot-mode POST XML
/rest/api/get-forum-bot-mode POST XML
/rest/api/create-forum POST XML Create a new forum.
/rest/api/create-forum-attachment POST XML Create an attachment for a forum.
/rest/api/create-forum-post POST XML Create a new post for a forum
/rest/api/update-forum POST XML Update the contents of the forum.
/rest/api/update-forum-post POST XML Update the content of a post of a forum.
/rest/api/update-forum-icon POST XML Update the icon of the forum.
/rest/api/check-forum POST XML Check to validate and returns a forum.
/rest/api/check-forum-post POST XML Check the post of the forum to validate and returns a post of a forum.
/rest/api/delete-forum POST XML Delete a forum.
/rest/api/delete-forum-post POST XML Delete a post of a forum.
/rest/api/flag-forum POST XML Flag a forum.
/rest/api/flag-forum-post POST XML Flag a post of a forum.
/rest/api/thumbs-up-forum POST XML Placing a thumbs up to a forum.
/rest/api/thumbs-down-forum POST XML Placing a thumbs down to a fourm.
/rest/api/subscribe-forum POST XML Subscribe to a forum.
/rest/api/unsubscribe-forum POST XML Unsubscribe to a forum.
/rest/api/star-forum POST XML Placing a star to a forum.

Script API URL Endpoints

URL Operation Type Description
/rest/api/get-forums POST XML Retrieve the forums.
/rest/api/get-forum-posts POST XML Retrieve the posts of a forum.
/rest/api/get-forum-users POST XML Get users of a forum.
/rest/api/get-forum-admins POST XML Get admins of a forum.
/rest/api/save-forum-bot-mode POST XML
/rest/api/get-forum-bot-mode POST XML
/rest/api/create-forum POST XML Create a new forum.
/rest/api/create-forum-attachment POST XML Create an attachment for a forum.
/rest/api/create-forum-post POST XML Create a new post for a forum
/rest/api/update-forum POST XML Update the contents of the forum.
/rest/api/update-forum-post POST XML Update the content of a post of a forum.
/rest/api/update-forum-icon POST XML Update the icon of the forum.
/rest/api/check-forum POST XML Check to validate and returns a forum.
/rest/api/check-forum-post POST XML Check the post of the forum to validate and returns a post of a forum.
/rest/api/delete-forum POST XML Delete a forum.
/rest/api/delete-forum-post POST XML Delete a post of a forum.
/rest/api/flag-forum POST XML Flag a forum.
/rest/api/flag-forum-post POST XML Flag a post of a forum.
/rest/api/thumbs-up-forum POST XML Placing a thumbs up to a forum.
/rest/api/thumbs-down-forum POST XML Placing a thumbs down to a fourm.
/rest/api/subscribe-forum POST XML Subscribe to a forum.
/rest/api/unsubscribe-forum POST XML Unsubscribe to a forum.
/rest/api/star-forum POST XML Placing a star to a forum.

Avatar API URL Endpoints

URL Operation Type Description
/rest/api/get-avatars POST XML Retrieve all avatars.
/rest/api/get-avatar-users POST XML Retrieve all users of an avatar.
/rest/api/get-avatar-admins POST XML Retrieve all admins of a selected avatar.
/rest/api/get-avatar-media POST XML Retrieve the media of an avatar.
/rest/api/create-avatar POST XML Create a new avatar.
/rest/api/create-avatar-media POST XML Create a media for an avatar.
/rest/api/save-avatar-media POST XML Save the media of an avatar.
/rest/api/save-avatar-background POST XML Save the background image of an avatar.
/rest/api/save-bot-avatar POST XML Choose an avatar and save for a bot.
/rest/api/delete-avatar POST XML Delete an avatar.
/rest/api/delete-avatar-media POST XML Delete a media of an avatar.
/rest/api/delete-avatar-background POST XML Delete a background image of an avatar.
/rest/api/check-avatar POST XML Validate an avatar and return it back to the user.
/rest/api/avatar-message POST XML
/rest/api/star-avatar POST XML Placing a star to an avatar.
/rest/api/flag-avatar POST XML Flag an avatar.
/rest/api/init-avatar POST XML
/rest/api/update-avatar POST XML Update the contents of an avatar.
/rest/api/update-avatar-icon POST XML Update the avatar icon.
/rest/api/thumbs-up-avatar POST XML Placing a thumbs up to an avatar.
/rest/api/thumbs-down-avatar POST XML Placing a thumbs down to an avatar.

Domain URL Endpoints

URL Operation Type Description
/rest/api/get-domains POST XML Get all available domains.
/rest/api/get-domain-users POST XML Get all users of a selected domain.
/rest/api/get-domain-admins POST XML Get all admins of a domain.
/rest/api/get-domain POST XML Return a domain.
/rest/api/get-domain-icon POST XML Return an icon of a domain.
/rest/api/create-domain POST XML Create a new domain.
/rest/api/check-domain POST XML Validate's and return's domain.
/rest/api/update-domain POST XML Update the content of a domain.
/rest/api/delete-domain POST XML Delete a domain
/rest/api/flag-domain POST XML Flag a domain.
/rest/api/star-domain POST XML Placing a star to a domain.
/rest/api/thumbs-up-domain POST XML Placing a thumbs up to a domain.
/rest/api/thumbs-down-domain POST XML Thumbs down to a selected domain.

Graphics URL Endpoints

URL Operation Type Description
/rest/api/get-graphics POST XML Retrieve all graphics.
/rest/api/get-graphic-users POST XML Get all users of a selected graphic.
/rest/api/get-graphic-admins POST XML Get all admins of a graphic.
/rest/api/update-graphic POST XML Update the contents of a graphic.
/rest/api/update-graphic-icon POST XML Update or change the current graphic icon.
/rest/api/update-graphic-media POST XML Update media content of a graphic.
/rest/api/create-graphic POST XML Create a new graphic.
/rest/api/delete-graphic POST XML Delete a selected graphic.
/rest/api/check-graphic POST XML Validate a graphic and return it back.
/rest/api/flag-graphic POST XML Flag a graphic.
/rest/api/star-graphic POST XML Placing a star to a graphic.
/rest/api/thumbs-up-graphic POST XML Thumbs up a selected graphic.
/rest/api/thumbs-down-graphic POST XML Thumbs down a selected graphic.

Analytics URL Endpoints

URL Operation Type Description
/rest/api/get-analytics POST XML Retrieve all analytics.
/rest/api/get-analytic-users POST XML Get all users of a selected analytic.
/rest/api/get-analytic-admins POST XML Get all admins of an analytic.
/rest/api/test-analytic POST XML Test a trained analytic model.
/rest/api/test-audio-analytic POST XML Test an audio model analytic.
/rest/api/test-object-detection-analytic POST XML Test an object detection image.
/rest/api/get-test-media-result POST XML Retrieve test media results.
/rest/api/report-media-analytic POST XML An analytic reprot.
/rest/api/train-analytic POST XML Train a model analytic.
/rest/api/delete-analytic-media POST XML Delete an analytic media.
/rest/api/delete-analytic-test-media POST XML Delete analytic test media.
/rest/api/get-analytic-media POST XML Retrieve all analytic media.
/rest/api/get-analytic-test-media POST XML Retrieve an analytic test media.
/rest/api/create-analytic-label POST XML Create a label to classify an object for a speicifc Analytic.
/rest/api/create-analytic-test-media-label POST XML Create a label to classify an object for a speicifc Analytic.
/rest/api/delete-analytic-label POST XML Delete a label of an analytic.
/rest/api/delete-analytic-test-media-label POST XML Delete a test media label of an analytic.
/rest/api/check-training POST XML Check current training of a model.
/rest/api/create-analytic POST XML Create a new Analytic.
/rest/api/update-analytic POST XML Update the content's of an analytic.
/rest/api/flag-analytic POST XML Flag an Analytic.
/rest/api/thumbs-up-analytic POST XML Thumbs up an Analytic.
/rest/api/thumbs-down-analytic POST XML Thumbs down to an Analytic.
/rest/api/star-analytic POST XML Placing a star to an analytic.
/rest/api/delete-analytic POST XML Delete an analytic.
/rest/api/check-analytic POST XML Validate an instance of an analytic and return it.
/rest/api/reset-data-analytic POST XML Reset the data of an analytic object.
/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://virtualdreamchat.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
attribute 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
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
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://virtualdreamchat.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://virtualdreamchat.com/rest/json/chat
Operation: POST
Type: JSON

Parameters

Parameter Required Type Description




User API URL Endpoints

Form-Check-User

URI: https://virtualdreamchat.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
attribute 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
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.

Example

https://virtualdreamchat.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://virtualdreamchat.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://virtualdreamchat.com/rest/api/get-bots
Operation: POST
Type: XML
The get-bots API used to retrieve all availabel bots.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterprivate
Filter all the private bot items.
filteradult
Filter all adult bot items.
type
Type of bot.
typefilter
Filter type of bot.
userfilter
Filter by users.



Get-Bot-Script-Source

URI: https://virtualdreamchat.com/rest/api/get-bot-script-source
Operation: POST
Type: XML
The get-bot-script-source API used to get the source of the script.

Parameters

Parameter Required Type Description



Delete-Bot

URI: https://virtualdreamchat.com/rest/api/delete-bot
Operation: POST
Type: XML
The delete-bot API delete's the selected bot.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot id for validation.
user
attribute The ID of the user who is deleting the bot. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Bot-Script

URI: https://virtualdreamchat.com/rest/api/delete-bot-script
Operation: POST
Type: XML
The delete-bot-script API used to delete a script from a bot.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot id for validation.
user
attribute The ID of the user who is deleting the bot. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
script
Bot script to be deleted.



Import-Bot-Script

URI: https://virtualdreamchat.com/rest/api/import-bot-script
Operation: POST
Type: XML
The import-bot-script API used to import a script to a bot.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot id for validation.
user
attribute The ID of the user who is deleting the bot. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
script
Bot script to be imported.



Import-Bot-Log

URI: https://virtualdreamchat.com/rest/api/import-bot-log
Operation: POST
Type: XML
The import-bot-log API used to import logs of a bot.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot id for validation.
user
attribute The ID of the user who is deleting the bot. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
log
Bot logs to be imported.



Save-Bot-Avatar

URI: https://virtualdreamchat.com/rest/api/save-bot-avatar
Operation: POST
Type: XML
The save-bot-avatar API used to choose an avatar and save for a bot.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Save-Bot-Script-Source

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

Parameters

Parameter Required Type Description



Create-Bot-Attachment

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

Parameters

Parameter Required Type Description
application
attribute Your application ID
id
An id of the forum for validation.
user
attribute The ID of the user who is creating the bot attachemnt. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the bot attachment.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
attachment
Bot attachemnt.



Up-Bot-Script

URI: https://virtualdreamchat.com/rest/api/up-bot-script
Operation: POST
Type: XML
The up-bot-script API used to move the bot script up.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot id for validation.
user
attribute The ID of the user who is checking instance admins. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
script
The selected script to be moved up.



Down-Bot-Script

URI: https://virtualdreamchat.com/rest/api/down-bot-script
Operation: POST
Type: XML
The down-bot-script API used to move down the bot script.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot id for validation.
user
attribute The ID of the user who is checking instance admins. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
script
The selected script to be moved down.



Get-Instances

URI: https://virtualdreamchat.com/rest/api/get-instances
Operation: POST
Type: XML
The get-instances API will retrieve all the available instances.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instances id for validation.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
media
Media.
filename
File name of the instance.
filetype
Type of the instance.
filterprivate
Filter all the private instance items.
filteradult
Filter all adult instance items.
type
Type of instance.
typefilter
Filter type of instance.
userfilter
Filter by users.
tag
Tag of instance.
category
Category of instance.
contentrating
Instances based on content rating.
restrict
All instance with restriction.
sort
Sort instances.



Get-Instance-Users

URI: https://virtualdreamchat.com/rest/api/get-instance-users
Operation: POST
Type: XML
The get-instance-users API will retrieve all users of that instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is getting the users in from the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Instance-Admins

URI: https://virtualdreamchat.com/rest/api/get-instance-admins
Operation: POST
Type: XML
The get-instance-admins API will retrieve all admins of that instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is checking instance admins. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-All-Instances

URI: https://virtualdreamchat.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://virtualdreamchat.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://virtualdreamchat.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
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
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
attribute 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://virtualdreamchat.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
attribute 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
attribute 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://virtualdreamchat.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://virtualdreamchat.com/rest/api/update-instance
Operation: POST
Type: XML
The update-instance API can let the user updates all contents of the selected bot instance

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the instance. The user must be registered with Bot Libre.
workspace
Workspace for a bot.
password
attribute The password of the user who is creating the instance.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The instance name that used to identify the instance.
alias
attribute Another name can be used for the new instance to be identified.
description
Brief description for the instance.
details
Details for the instance.
disclaimer
Disclaimer regarding the new instance.
license
License to release the instance and all its content under.
website
URL for the instance if it has it's own website.
website-subdomain
You can choose a subdomain to host your forum's own website, or give a domain that you have registered and forward to this server's ip address.
categories
On what category would you place your instance. Must select at least one of the categories. (Misc, Fun, Education, Friends).
tags
Tags for your instance
isPrivate
attribute Instance can be private, and accessed only by the user.
isHidden
attribute Hidden instance will not be available to public.
accessMode
attribute Instance will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Instance will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Instance can be viewed or rated for (Everyone, Teen, Mature).



Update-Instance-Icon

URI: https://virtualdreamchat.com/rest/api/update-instance-icon
Operation: POST
Type: XML
The update-instance-icon API it let's the user change the icon of the bot instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is updating instance icon. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
image-icon
img Update instance icon



Create-Instance

URI: https://virtualdreamchat.com/rest/api/create-instance
Operation: POST
Type: XML
The create-instance API to create a new bot instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the instance. The user must be registered with Bot Libre.
template
Type of bot to create.
password
attribute The password of the user who is creating the instance.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The instance name that used to identify the instance.
alias
attribute Another name can be used for the new instance to be identified.
description
Brief description for the instance.
details
Details for the instance.
disclaimer
Disclaimer regarding the new instance.
license
License to release the instance and all its content under.
website
URL for the instance if it has it's own website.
categories
On what category would you place your instance. Must select at least one of the categories. (Misc, Fun, Education, Friends).
tags
Tags for your instance
isPrivate
attribute Instance can be private, and accessed only by the user.
isHidden
attribute Hidden instance will not be available to public.
accessMode
attribute Instance will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Instance will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Instance can be viewed or rated for (Everyone, Teen, Mature).



Edit-Instance

URI: https://virtualdreamchat.com/rest/api/edit-instance
Operation: POST
Type: XML
The edit-instance API to edit and update the bot instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the instance. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the instance.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The instance name that used to identify the instance.
alias
attribute Another name can be used for the new instance to be identified.
description
Brief description for the instance.
details
Details for the instance.
disclaimer
Disclaimer regarding the new instance.
license
License to release the instance and all its content under.
website
URL for the instance if it has it's own website.
categories
On what category would you place your instance. Must select at least one of the categories. (Misc, Fun, Education, Friends).
tags
Tags for your instance
isPrivate
attribute Instance can be private, and accessed only by the user.
isHidden
attribute Hidden instance will not be available to public.
accessMode
attribute Instance will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Instance will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Instance can be viewed or rated for (Everyone, Teen, Mature).



Delete-Instance

URI: https://virtualdreamchat.com/rest/api/delete-instance
Operation: POST
Type: XML
The delete-instance API to delete a bot instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Instance

URI: https://virtualdreamchat.com/rest/api/flag-instance
Operation: POST
Type: XML
The flag-instance API Flag a bot instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Star-Instance

URI: https://virtualdreamchat.com/rest/api/star-instance
Operation: POST
Type: XML
The star-instance API star a bot instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who wants to star the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Train-Instance

URI: https://virtualdreamchat.com/rest/api/train-instance
Operation: POST
Type: XML
The train-instance API train a chat bot instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Up-Instance

URI: https://virtualdreamchat.com/rest/api/thumbs-up-instance
Operation: POST
Type: XML
The thumbs-up-instance API a user can place a thumbs up to a chat bot instance.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is placing a thumbs up on the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Instance

URI: https://virtualdreamchat.com/rest/api/thumbs-down-instance
Operation: POST
Type: XML
The thumbs-down-instance a user can place a thumbs down to a chat bot instance

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is placing a thumbs down on an instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.




Forum API URL Endpoints

Get-Forums

URI: https://virtualdreamchat.com/rest/api/get-forums
Operation: POST
Type: XML
The get-forums API used to retrieve available forums.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Forum-Posts

URI: https://virtualdreamchat.com/rest/api/get-forum-posts
Operation: POST
Type: XML
The get-forum-posts API used to retrieve available posts of each forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Instance id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Forum-Users

URI: https://virtualdreamchat.com/rest/api/get-forum-users
Operation: POST
Type: XML
The get-forum-users API used to retrieve users of each forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is getting the users in the forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Forum-Admins

URI: https://virtualdreamchat.com/rest/api/get-forum-admins
Operation: POST
Type: XML
The get-forum-admins API used to retrieve admins of each forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is checking forum admins. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Save-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Get-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Create-Forum

URI: https://virtualdreamchat.com/rest/api/create-forum
Operation: POST
Type: XML
The create-forum API to create a new forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The forum name that used to identify the forum.
alias
attribute Another name can be used for the new forum to be identified.
description
Brief description for the forum.
details
Details for the forum.
disclaimer
Disclaimer regarding the new forum.
license
License to release the forum and all its content under.
website
URL for the forum if it has it's own website.
categories
On what category would you place your forum. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags
Tags for your forum
isPrivate
attribute forum can be private, and accessed only by the user.
isHidden
attribute Hidden forum will not be available to public.
accessMode
attribute Forum will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Forum will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Forum can be viewed or rated for (Everyone, Teen, Mature).
post-mode
Who can post on the forum.
post-reply-mode
Who can reply to a post in the forum.



Create-Forum-Attachment

URI: https://virtualdreamchat.com/rest/api/create-forum-attachment
Operation: POST
Type: XML
The create-forum-attachment API to craete a forum that contains an attachment.

Parameters

Parameter Required Type Description
application
attribute Your application ID
id
An id of the forum for validation.
user
attribute The ID of the user who is creating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
attachment
Forum attachemnt.



Create-Forum-Post

URI: https://virtualdreamchat.com/rest/api/create-forum-post
Operation: POST
Type: XML
The create-forum-post API to create a new post for a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID
id
An id of the forum for validation.
user
attribute The ID of the user who is creating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
topic
Post's topic
details
Type of a markup
body
Test Area
tags
Tags
subscribe-replies
boolean Subscribe to this post to be notified once a reply is posted



Update-Forum

URI: https://virtualdreamchat.com/rest/api/update-forum
Operation: POST
Type: XML
The update-forum API used to update the contents of the forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is updating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is updating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The forum name that used to identify the forum.
alias
attribute Another name can be used for the new forum to be identified.
description
Brief description for the forum.
details
Details for the forum.
disclaimer
Disclaimer regarding the new forum.
license
License to release the forum and all its content under.
website
URL for the forum if it has it's own website.
categories
On what category would you place your forum. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags
Tags for your forum
isPrivate
attribute forum can be private, and accessed only by the user.
isHidden
attribute Hidden forum will not be available to public.
accessMode
attribute Forum will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Forum will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Forum can be viewed or rated for (Everyone, Teen, Mature).
post-mode
Who can post on the forum.
post-reply-mode
Who can reply to a post in the forum.



Update-Forum-Post

URI: https://virtualdreamchat.com/rest/api/update-forum-post
Operation: POST
Type: XML
The update-forum-post API updates the content of a post of a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID
id
An id of the forum for validation.
user
attribute The ID of the user who is creating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
topic
Post's topic
details
Type of a markup
body
Test Area
tags
Tags
subscribe-replies
boolean Subscribe to this post to be notified once a reply is posted



Update-Forum-Icon

URI: https://virtualdreamchat.com/rest/api/update-forum-icon
Operation: POST
Type: XML
THe update-forum-icon API used to change the icon of the fourm.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is updating forum icon. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
image-icon
img Update forum icon



Check-Forum

URI: https://virtualdreamchat.com/rest/api/check-forum
Operation: POST
Type: XML
The check-forum API validate and returns a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Check-Forum-Post

URI: https://virtualdreamchat.com/rest/api/check-forum-post
Operation: POST
Type: XML
The check-forum-post API check the post of the forum to validate and returns a post of a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Forum

URI: https://virtualdreamchat.com/rest/api/delete-forum
Operation: POST
Type: XML
The delete-forum API to delete a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Forum-Post

URI: https://virtualdreamchat.com/rest/api/delete-forum-post
Operation: POST
Type: XML
The delete-forum-post API delete's a post of a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Forum

URI: https://virtualdreamchat.com/rest/api/flag-forum
Operation: POST
Type: XML
The flag-forum API used to flag a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is placing a flag to a forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Forum-Post

URI: https://virtualdreamchat.com/rest/api/flag-forum-post
Operation: POST
Type: XML
The flag-forum-post API flag's a post of a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is placing a flag to a forum post. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Up-Forum

URI: https://virtualdreamchat.com/rest/api/thumbs-up-forum
Operation: POST
Type: XML
The thumbs-up-forum API used to place a thumbs up to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is placing a thumbs up to a forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Forum

URI: https://virtualdreamchat.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
The thumbs-down-forum API used to place thumbs down to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is placing a thumbs down to a forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Subscribe-Forum

URI: https://virtualdreamchat.com/rest/api/subscribe-forum
Operation: POST
Type: XML
The subscribe-forum API is to let a user subscribe to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Unsubscribe-Forum

URI: https://virtualdreamchat.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML
The unsubscribe-forum API is to let the user unsubscribe to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Star-Forum

URI: https://virtualdreamchat.com/rest/api/star-forum
Operation: POST
Type: XML
The star-forum API is to let a user place a star to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is placing a star to a forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.




Script API URL Endpoints

Get-Forums

URI: https://virtualdreamchat.com/rest/api/get-forums
Operation: POST
Type: XML
The get-forums API used to retrieve available forums.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterprivate
Filter all the private forum items.
filteradult
Filter all adult forum items.
type
Type of forum.
typefilter
Filter type of forum.
userfilter
Filter by users.



Get-Forum-Posts

URI: https://virtualdreamchat.com/rest/api/get-forum-posts
Operation: POST
Type: XML
The get-forum-posts API used to retrieve available posts of each forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Forum-Users

URI: https://virtualdreamchat.com/rest/api/get-forum-users
Operation: POST
Type: XML
The get-forum-users API used to retrieve users of each forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is getting the users in the forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Forum-Admins

URI: https://virtualdreamchat.com/rest/api/get-forum-admins
Operation: POST
Type: XML
The get-forum-admins API is to retrieve all admins of a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute forum id for validation.
user
attribute The ID of the user who is checking forum admins. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Save-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Get-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Create-Forum

URI: https://virtualdreamchat.com/rest/api/create-forum
Operation: POST
Type: XML
The create-forum API is used to create a new forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The forum name that used to identify the forum.
alias
attribute Another name can be used for the new forum to be identified.
description
Brief description for the forum.
details
Details for the forum.
disclaimer
Disclaimer regarding the new forum.
license
License to release the forum and all its content under.
website
URL for the forum if it has it's own website.
categories
On what category would you place your forum. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags
Tags for your forum
isPrivate
attribute forum can be private, and accessed only by the user.
isHidden
attribute Hidden forum will not be available to public.
accessMode
attribute Forum will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Forum will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Forum can be viewed or rated for (Everyone, Teen, Mature).
post-mode
Who can post on the forum.
post-reply-mode
Who can reply to a post in the forum.



Create-Forum-Attachment

URI: https://virtualdreamchat.com/rest/api/create-forum-attachment
Operation: POST
Type: XML
The create-forum-attachment API to craete a forum that contains an attachment.

Parameters

Parameter Required Type Description
application
attribute Your application ID
id
An id of the forum for validation.
user
attribute The ID of the user who is creating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
attachment
Forum attachemnt.



Create-Forum-Post

URI: https://virtualdreamchat.com/rest/api/create-forum-post
Operation: POST
Type: XML
The create-forum-post API to create a new post for a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID
id
An id of the forum for validation.
user
attribute The ID of the user who is creating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
topic
Post's topic
details
Type of a markup
body
Test Area
tags
Tags
subscribe-replies
boolean Subscribe to this post to be notified once a reply is posted



Update-Forum

URI: https://virtualdreamchat.com/rest/api/update-forum
Operation: POST
Type: XML
The update-forum API used to update the contents of the forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute The ID of forum for validation.
user
attribute The ID of the user who is creating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The forum name that used to identify the forum.
alias
attribute Another name can be used for the new forum to be identified.
workspace
Name of the workspace.
description
Brief description for the forum.
details
Details for the forum.
disclaimer
Disclaimer regarding the new forum.
license
License to release the forum and all its content under.
website
URL for the forum if it has it's own website.
website-subdomain
attribute You can choose a subdomain to host your forum's own website, or give a domain that you have registered and forward to this server's ip address.
categories
On what category would you place your forum. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags
Tags for your forum
isPrivate
attribute forum can be private, and accessed only by the user.
isHidden
attribute Hidden forum will not be available to public.
accessMode
attribute Forum will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Forum will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Forum can be viewed or rated for (Everyone, Teen, Mature).
post-mode
Who can post on the forum.
post-reply-mode
Who can reply to a post in the forum.



Update-Forum-Post

URI: https://virtualdreamchat.com/rest/api/update-forum-post
Operation: POST
Type: XML
The update-forum-post API updates the content of a post of a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID
id
An id of the forum for validation.
user
attribute The ID of the user who is creating the forum. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
topic
Post's topic
details
Type of a markup
body
Test Area
tags
Tags
featured
boolean For featured posts.



Update-Forum-Icon

URI: https://virtualdreamchat.com/rest/api/update-forum-icon
Operation: POST
Type: XML
THe update-forum-icon API used to change the icon of the fourm.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is updating forum icon. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
image-icon
img Update forum icon



Check-Forum

URI: https://virtualdreamchat.com/rest/api/check-forum
Operation: POST
Type: XML
The check-forum API validate and returns a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Check-Forum-Post

URI: https://virtualdreamchat.com/rest/api/check-forum-post
Operation: POST
Type: XML
The check-forum-post API check the post of the forum to validate and returns a post of a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Forum

URI: https://virtualdreamchat.com/rest/api/delete-forum
Operation: POST
Type: XML
The delete-forum API to delete a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Forum-Post

URI: https://virtualdreamchat.com/rest/api/delete-forum-post
Operation: POST
Type: XML
The delete-forum-post API delete's a post of a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Forum

URI: https://virtualdreamchat.com/rest/api/flag-forum
Operation: POST
Type: XML
The flag-forum API used to flag a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is placing a flag to a forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Forum-Post

URI: https://virtualdreamchat.com/rest/api/flag-forum-post
Operation: POST
Type: XML
The flag-forum-post API flag's a post of a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Up-Forum

URI: https://virtualdreamchat.com/rest/api/thumbs-up-forum
Operation: POST
Type: XML
The thumbs-up-forum API used to place a thumbs up to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is placing a thumbs up to a forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Forum

URI: https://virtualdreamchat.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
The thumbs-down-forum API used to place thumbs down to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Subscribe-Forum

URI: https://virtualdreamchat.com/rest/api/subscribe-forum
Operation: POST
Type: XML
The subscribe-forum API is to let a user subscribe to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is unsubscribing to a forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Unsubscribe-Forum

URI: https://virtualdreamchat.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML
The unsubscribe-forum API is to let the user unsubscribe to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is unsubscribing to a forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Star-Forum

URI: https://virtualdreamchat.com/rest/api/star-forum
Operation: POST
Type: XML
The star-forum API is to let a user place a star to a forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum id for validation.
user
attribute The ID of the user who is unsubscribing to a forum. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.




Avatar API URL Endpoints

Get-Avatars

URI: https://virtualdreamchat.com/rest/api/get-avatars
Operation: POST
Type: XML
THe get-avatars API is used to retrieve available avatars.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterprivate
Filter all the private avatar items.
filteradult
Filter all adult avatar items.
type
Type of avatar.
typefilter
Filter type of avatar.
userfilter
Filter by users.



Get-Avatar-Users

URI: https://virtualdreamchat.com/rest/api/get-avatar-users
Operation: POST
Type: XML
The get-avatars-users API used to retrieve all users that are related to that avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute avatars id for validation.
user
attribute The ID of the user who is getting the users in the avatar. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Avatar-Admins

URI: https://virtualdreamchat.com/rest/api/get-avatar-admins
Operation: POST
Type: XML
The get-avatar-admins API used to retrieve all admins of a selected avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute avatar id for validation.
user
attribute The ID of the user who is checking avatar admins. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Avatar-Media

URI: https://virtualdreamchat.com/rest/api/get-avatar-media
Operation: POST
Type: XML
The get-avatar-media API used to retrieve the media of an avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Create-Avatar

URI: https://virtualdreamchat.com/rest/api/create-avatar
Operation: POST
Type: XML
The create-avatar API used to create a new avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the avatar. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the avatar.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The avatar name that used to identify the avatar.
alias
attribute Another name can be used for the new avatar to be identified.
description
Brief description for the avatar.
details
Details for the avatar.
disclaimer
Disclaimer regarding the new avatar.
license
License to release the avatar and all its content under.
website
URL for the avatar if it has it's own website.
categories
On what category would you place your avatar. Must select at least one of the categories. (People, 3D, Video, MP4).
tags
Tags for your avatar
isPrivate
attribute Avatar can be private, and accessed only by the user.
isHidden
attribute Hidden avatar will not be available to public.
accessMode
attribute Avatar will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Avatar will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Avatar can be viewed or rated for (Everyone, Teen, Mature).



Create-Avatar-Media

URI: https://virtualdreamchat.com/rest/api/create-avatar-media
Operation: POST
Type: XML
The create-avatar-media API used to create a media for an avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
media
New avatar media to be uploaded.



Save-Avatar-Media

URI: https://virtualdreamchat.com/rest/api/save-avatar-media
Operation: POST
Type: XML
The save-avatar-media API used to save the changes current media of an avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
media
Avatar selected media to be saved.



Save-Avatar-Background

URI: https://virtualdreamchat.com/rest/api/save-avatar-background
Operation: POST
Type: XML
The save-avatar-background API saves the background image of an avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
background
Avatar background to be saved.



Save-Bot-Avatar

URI: https://virtualdreamchat.com/rest/api/save-bot-avatar
Operation: POST
Type: XML
The save-bot-avatar API used to choose an avatar and save for a bot.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Avatar

URI: https://virtualdreamchat.com/rest/api/delete-avatar
Operation: POST
Type: XML
The delete-avatar API used to delete a selected avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Avatar-Media

URI: https://virtualdreamchat.com/rest/api/delete-avatar-media
Operation: POST
Type: XML
The delete-avatar-media API used to delete a media of an avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
media
Avatar selected media to be deleted.



Delete-Avatar-Background

URI: https://virtualdreamchat.com/rest/api/delete-avatar-background
Operation: POST
Type: XML
The delete-avatar-background API used to delete a background image of an avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
background
Background image of an avatar.



Check-Avatar

URI: https://virtualdreamchat.com/rest/api/check-avatar
Operation: POST
Type: XML
The check-avatar API is used to validate and return the avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Avatar-Message

URI: https://virtualdreamchat.com/rest/api/avatar-message
Operation: POST
Type: XML
The avatar-message API

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
User who has access to modify the Analytic.
password
Password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
message
Message.



Star-Avatar

URI: https://virtualdreamchat.com/rest/api/star-avatar
Operation: POST
Type: XML
The star-avatar API used for the user to star an avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Avatar

URI: https://virtualdreamchat.com/rest/api/flag-avatar
Operation: POST
Type: XML
The flag-avatar API used to flag an avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Init-Avatar

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

Parameters

Parameter Required Type Description



Update-Avatar

URI: https://virtualdreamchat.com/rest/api/update-avatar
Operation: POST
Type: XML
The update-avatar API used to update and change the content of an avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the avatar. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the avatar.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The avatar name that used to identify the avatar.
alias
attribute Another name can be used for the new avatar to be identified.
description
Brief description for the avatar.
details
Details for the avatar.
disclaimer
Disclaimer regarding the new avatar.
license
License to release the avatar and all its content under.
website
URL for the avatar if it has it's own website.
categories
On what category would you place your avatar. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags
Tags for your avatar
isPrivate
attribute Instance can be private, and accessed only by the user.
isHidden
attribute Hidden avatar will not be available to public.
accessMode
attribute Domain will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Avatar will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Avatar can be viewed or rated for (Everyone, Teen, Mature).
creation-mode
Who can create channels, forums, bots in this avatar.



Update-Avatar-Icon

URI: https://virtualdreamchat.com/rest/api/update-avatar-icon
Operation: POST
Type: XML
The update-avatar-icon API used to update the avatar's icon

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute avatar id for validation.
user
attribute The ID of the user who is updating avatar icon. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
image-icon
img Update avatar icon



Thumbs-Up-Avatar

URI: https://virtualdreamchat.com/rest/api/thumbs-up-avatar
Operation: POST
Type: XML
The thumbs-up-avatar API used to place a thumbs up on a selected avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Avatar

URI: https://virtualdreamchat.com/rest/api/thumbs-down-avatar
Operation: POST
Type: XML
The thumbs-down-avatar API used to place a thumbs down to a selected avatar.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.




Domain URL Endpoints

Get-Domains

URI: https://virtualdreamchat.com/rest/api/get-domains
Operation: POST
Type: XML
The get-domains API used to retrieve all available domains.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterprivate
Filter all the private domain items.
filteradult
Filter all adult domain items.
type
Type of domain.
typefilter
Filter type of domain.
userfilter
Filter by users.



Get-Domain-Users

URI: https://virtualdreamchat.com/rest/api/get-domain-users
Operation: POST
Type: XML
The get-domain-users API used to retrieve all users of a domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is getting the users in the domain. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Domain-Admins

URI: https://virtualdreamchat.com/rest/api/get-domain-admins
Operation: POST
Type: XML
The get-domain-admins API used to retrieve all admins of a domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is checking the domain admins. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Domain

URI: https://virtualdreamchat.com/rest/api/get-domain
Operation: POST
Type: XML
The get-domain API retrieve a selected domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Domain-Icon

URI: https://virtualdreamchat.com/rest/api/get-domain-icon
Operation: POST
Type: XML
The get-domain-icon API used to return an icon of a domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is updating domain's icon. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Create-Domain

URI: https://virtualdreamchat.com/rest/api/create-domain
Operation: POST
Type: XML
The create-domain API create's a new domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the domain. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the domain.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The domain name that used to identify the domain.
alias
attribute Another name can be used for the new domain to be identified.
description
Brief description for the domain.
details
Details for the domain.
disclaimer
Disclaimer regarding the new domain.
license
License to release the domain and all its content under.
website
URL for the domain if it has it's own website.
website-subdomain
You can choose a subdomain to host your forum's own website, or give a domain that you have registered and forward to this server's ip address.
categories
On what category would you place your domain. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags
Tags for your domain
isPrivate
attribute Instance can be private, and accessed only by the user.
isHidden
attribute Hidden domain will not be available to public.
accessMode
attribute Domain will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Domain will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Domain can be viewed or rated for (Everyone, Teen, Mature).
creation-mode
Who can create channels, forums, bots in this domain.



Check-Domain

URI: https://virtualdreamchat.com/rest/api/check-domain
Operation: POST
Type: XML
The check-domain API used to validate and return a domain back.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Update-Domain

URI: https://virtualdreamchat.com/rest/api/update-domain
Operation: POST
Type: XML
The update-domain API updates the contents of the domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute domain id for validation.
user
attribute The ID of the user who is updating the domain. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the domain.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The domain name that used to identify the domain.
alias
attribute Another name can be used for the new domain to be identified.
description
Brief description for the domain.
details
Details for the domain.
disclaimer
Disclaimer regarding the new domain.
license
License to release the domain and all its content under.
website
URL for the domain if it has it's own website.
website-subdomain
You can choose a subdomain to host your forum's own website, or give a domain that you have registered and forward to this server's ip address.
categories
On what category would you place your domain. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags
Tags for your domain
isPrivate
attribute Instance can be private, and accessed only by the user.
isHidden
attribute Hidden domain will not be available to public.
accessMode
attribute Domain will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Domain will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Domain can be viewed or rated for (Everyone, Teen, Mature).
creation-mode
Who can create channels, forums, bots in this domain.



Delete-Domain

URI: https://virtualdreamchat.com/rest/api/delete-domain
Operation: POST
Type: XML
The delete-domain API delete a selected domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Domain

URI: https://virtualdreamchat.com/rest/api/flag-domain
Operation: POST
Type: XML
The falg-domain API used to flag a Domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Star-Domain

URI: https://virtualdreamchat.com/rest/api/star-domain
Operation: POST
Type: XML
The star-domain API used to place a star to a domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Up-Domain

URI: https://virtualdreamchat.com/rest/api/thumbs-up-domain
Operation: POST
Type: XML
The thumbs-up-domain API used to thumbs up a domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Domain

URI: https://virtualdreamchat.com/rest/api/thumbs-down-domain
Operation: POST
Type: XML
The thumbs-down-domain API used to thumbs down to a selected domain.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.




Graphics URL Endpoints

Get-Graphics

URI: https://virtualdreamchat.com/rest/api/get-graphics
Operation: POST
Type: XML
The get-graphics API retrieve all available graphics.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterprivate
Filter all the private graphic items.
filteradult
Filter all adult grapic items.
type
Type of graphic.
typefilter
Filter type of graphic.
userfilter
Filter by users.



Get-Graphic-Users

URI: https://virtualdreamchat.com/rest/api/get-graphic-users
Operation: POST
Type: XML
The get-graphic-users API return all users of a selected graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute graphic id for validation.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
media
Media.
filename
File name of the graphic.
filetype
Type of the graphic.



Get-Graphic-Admins

URI: https://virtualdreamchat.com/rest/api/get-graphic-admins
Operation: POST
Type: XML
The get-graphic-admins API returns all admins of a selected graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute graphic id for validation.
user
attribute The ID of the user who is checking graphic admins. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Update-Graphic

URI: https://virtualdreamchat.com/rest/api/update-graphic
Operation: POST
Type: XML
The update-graphic API used to update the contents of a graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
id to validate a graphic.
user
attribute The ID of the user who is updating the graphic. The user must be registered with Bot Libre.
password
attribute The password of the user who is updating the graphic.
name
attribute The graphic name that used to identify the graphic.
alias
attribute Another name can be used for the new graphic to be identified.
description
Brief description for the graphic.
details
Details for the graphic.
disclaimer
Disclaimer regarding the new graphic.
license
License to release the graphic and all its content under.
website
URL for the graphic if it has it's own website.
categories
On what category would you place your graphic. Must select at least one of the categories. (Image, Audio, Data, Misc).
tags
Tag your Graphic
isPrivate
attribute Graphic can be private, and accessed only by the user.
isHidden
attribute Hidden graphic will not be available to public.
accessMode
attribute Graphic will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Graphic will be able to copy by based on the following options (Everyone, Users, Members, Admin).
accessMode
attribute Graphic can be viewed or rated for (Everyone, Teen, Mature).



Update-Graphic-Icon

URI: https://virtualdreamchat.com/rest/api/update-graphic-icon
Operation: POST
Type: XML
The update-graphic-icon API used to change and update the graphic icon.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute graphic id for validation.
user
attribute The ID of the user who is updating graphic icon. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
image-icon
img Update graphic icon



Update-Graphic-Media

URI: https://virtualdreamchat.com/rest/api/update-graphic-media
Operation: POST
Type: XML
The update-graphic-media API used to update the media content of the selected graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the domain. The user must be registered with Bot Libre.
id
attribute graphic id for validation.
password
attribute The password of the user who is creating the domain.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The domain name that used to identify the domain.



Create-Graphic

URI: https://virtualdreamchat.com/rest/api/create-graphic
Operation: POST
Type: XML
The create-graphic API used to create a new graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the graphic. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the graphic.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The graphic name that used to identify the graphic.
alias
attribute Another name can be used for the new graphic to be identified.
description
Brief description for the graphic.
details
Details for the graphic.
disclaimer
Disclaimer regarding the new graphic.
license
License to release the graphic and all its content under.
website
URL for the graphic if it has it's own website.
categories
On what category would you place your graphic. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags
Tags for your graphic
isPrivate
attribute Instance can be private, and accessed only by the user.
isHidden
attribute Hidden graphic will not be available to public.
accessMode
attribute Graphic will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Graphic will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Graphic can be viewed or rated for (Everyone, Teen, Mature).
creation-mode
Who can create channels, forums, bots in this graphic.



Delete-Graphic

URI: https://virtualdreamchat.com/rest/api/delete-graphic
Operation: POST
Type: XML
The delete-graphic API used to delete a selected graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Check-Graphic

URI: https://virtualdreamchat.com/rest/api/check-graphic
Operation: POST
Type: XML
The check-graphic API used to validate a graphic and return it back.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Graphic

URI: https://virtualdreamchat.com/rest/api/flag-graphic
Operation: POST
Type: XML
The flag-graphic API used to flag a graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Star-Graphic

URI: https://virtualdreamchat.com/rest/api/star-graphic
Operation: POST
Type: XML
The star-graphic API used to place a star to a graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Up-Graphic

URI: https://virtualdreamchat.com/rest/api/thumbs-up-graphic
Operation: POST
Type: XML
The thumbs-up-graphic API used to place a thumbs up on a selected graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Graphic

URI: https://virtualdreamchat.com/rest/api/thumbs-down-graphic
Operation: POST
Type: XML
The thumbs-down-graphic API used to place a thumbs down to a selected graphic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.




Analytics URL Endpoints

Get-Analytics

URI: https://virtualdreamchat.com/rest/api/get-analytics
Operation: POST
Type: XML
The get-analytics API used to retrieve all avaiable analytics.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterprivate
Filter all the private analytic items.
filteradult
Filter all adult analytic items.
type
Type of analytics.
typefilter
Filter type of analytic.
userfilter
Filter by users.
tag
Tag of analytic.
category
Category of analytic.



Get-Analytic-Users

URI: https://virtualdreamchat.com/rest/api/get-analytic-users
Operation: POST
Type: XML
The get-analytic-users API used to retrieve all users of an analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute analytic id for validation.
user
attribute The ID of the user who is getting the users in the analytic. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Analytic-Admins

URI: https://virtualdreamchat.com/rest/api/get-analytic-admins
Operation: POST
Type: XML
The get-analytic-admins API used to retrieve all admins of a selected analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute analytic id for validation.
user
attribute The ID of the user who is checking analytic admins. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Test-Analytic

URI: https://virtualdreamchat.com/rest/api/test-analytic
Operation: POST
Type: XML
The test-analytic API used to test a trained analytic model with a specific instructions.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
image
The image as input to be recognized.
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
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Test-Audio-Analytic

URI: https://virtualdreamchat.com/rest/api/test-audio-analytic
Operation: POST
Type: XML
The test-audio-analytic API used to test an audio model analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
audio
Audio file needed to audio recognize.



Test-Object-Detection-Analytic

URI: https://virtualdreamchat.com/rest/api/test-object-detection-analytic
Operation: POST
Type: XML
The test-object-detection-analytic API used to test an object detection analytic model with a specific instructions.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
image
An image needed to object detect.



Get-Test-Media-Result

URI: https://virtualdreamchat.com/rest/api/get-test-media-result
Operation: POST
Type: XML
The get-test-media-result API retrieve test media results.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Report-Media-Analytic

URI: https://virtualdreamchat.com/rest/api/report-media-analytic
Operation: POST
Type: XML
The report-media-analytic API used to get an analytic reprot.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Train-Analytic

URI: https://virtualdreamchat.com/rest/api/train-analytic
Operation: POST
Type: XML
The train-analytic API used to train an analytic model.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Analytic-Media

URI: https://virtualdreamchat.com/rest/api/delete-analytic-media
Operation: POST
Type: XML
The delete-analytic-media API used to delete a select analytic media.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Analytic-Test-Media

URI: https://virtualdreamchat.com/rest/api/delete-analytic-test-media
Operation: POST
Type: XML
The delete-analytic-test-media API used to delete a test media of an analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Analytic-Media

URI: https://virtualdreamchat.com/rest/api/get-analytic-media
Operation: POST
Type: XML
The get-analytic-media API used to retrieve all analytic media.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Analytic-Test-Media

URI: https://virtualdreamchat.com/rest/api/get-analytic-test-media
Operation: POST
Type: XML
The get-analytic-test-media API retrieve a test media of an analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Create-Analytic-Label

URI: https://virtualdreamchat.com/rest/api/create-analytic-label
Operation: POST
Type: XML
Create a label or labels for an Analytic. Each label is a classifier. Each label is like a package will contain a set of images. This is required before starting the training phase for image recognition. Each Analytic must at least has two labels.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
User who has access to modify the Analytic.
password
Password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
analytic-label
label or a name to classify a specific image, and will contain all the images of the same object.



Create-Analytic-Test-Media-Label

URI: https://virtualdreamchat.com/rest/api/create-analytic-test-media-label
Operation: POST
Type: XML
Create a label or labels for an Analytic. Each label is a classifier. Each label is like a package will contain a set of images. This is required before starting the training phase for image recognition. Each Analytic must at least has two labels.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
User who has access to modify the Analytic.
password
Password of the user.
analytic-label
label or a name to classify a specific image, and will contain all the images of the same object.



Delete-Analytic-Label

URI: https://virtualdreamchat.com/rest/api/delete-analytic-label
Operation: POST
Type: XML
The delete-analytic-label API used to delete a selected label of an analytic object.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
User who has access to modify the Analytic.
password
Password of the user.
analytic-label
label or a name to classify a specific image, and will contain all the images of the same object.



Delete-Analytic-Test-Media-Label

URI: https://virtualdreamchat.com/rest/api/delete-analytic-test-media-label
Operation: POST
Type: XML
The delete-analytic-test-media-label API used to delete a test media label of an analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
User who has access to modify the Analytic.
password
Password of the user.
analytic-label
label or a name to classify a specific image, and will contain all the images of the same object.



Check-Training

URI: https://virtualdreamchat.com/rest/api/check-training
Operation: POST
Type: XML
The check-training API used to retrieve some information of the current training of a model.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the analytic. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the analytic.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The analytic name that used to identify the analytic.
alias
attribute Another name can be used for the new analytic to be identified.



Create-Analytic

URI: https://virtualdreamchat.com/rest/api/create-analytic
Operation: POST
Type: XML
The create-analytic API create a new Analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the analytic. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the analytic.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The analytic name that used to identify the analytic.
alias
attribute Another name can be used for the new analytic to be identified.
description
Brief description for the Analytic.
details
Details for the Analytic.
disclaimer
Disclaimer regarding the new Analytic.
license
License to release the Analytic and all its content under.
website
URL for the Analytic if it has it's own website.
categories
On what category would you place your Analytic. Must select at least one of the categories. (Image, Audio, Data, Misc).
tags
Tag your Analytic
isPrivate
attribute Analytic can be private, and accessed only by the user.
isHidden
attribute Hidden analytic will not be available to public.
accessMode
attribute Analytic will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Analytic will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating
attribute Analytic can be viewed or rated for (Everyone, Teen, Mature).



Update-Analytic

URI: https://virtualdreamchat.com/rest/api/update-analytic
Operation: POST
Type: XML
The update-analytic API update or change the details of a selected analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is creating the analytic. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the analytic.
name
attribute The analytic name that used to identify the analytic.
alias
attribute Another name can be used for the new analytic to be identified.
description
Brief description for the Analytic.
details
Details for the Analytic.
disclaimer
Disclaimer regarding the new Analytic.
license
License to release the Analytic and all its content under.
website
URL for the Analytic if it has it's own website.
categories
On what category would you place your Analytic. Must select at least one of the categories. (Image, Audio, Data, Misc).
tags
Tag your Analytic
isPrivate
attribute Analytic can be private, and accessed only by the user.
isHidden
attribute Hidden analytic will not be available to public.
accessMode
attribute Analytic will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode
attribute Analytic will be able to copy by based on the following options (Everyone, Users, Members, Admin).
accessMode
attribute Analytic can be viewed or rated for (Everyone, Teen, Mature).



Flag-Analytic

URI: https://virtualdreamchat.com/rest/api/flag-analytic
Operation: POST
Type: XML
The flag-analytic API used to place a flag to an Analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Up-Analytic

URI: https://virtualdreamchat.com/rest/api/thumbs-up-analytic
Operation: POST
Type: XML
The thumbs-up-analytic API used to thumbs up an Analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Analytic

URI: https://virtualdreamchat.com/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
The thumbs-down-analytic API used to thumbs down to an Analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Star-Analytic

URI: https://virtualdreamchat.com/rest/api/star-analytic
Operation: POST
Type: XML
The star-analytic API is used to star an analytic object.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Analytic

URI: https://virtualdreamchat.com/rest/api/delete-analytic
Operation: POST
Type: XML
The delete-analyic API used to delete a selected analytic.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Check-Analytic

URI: https://virtualdreamchat.com/rest/api/check-analytic
Operation: POST
Type: XML
The check-analytic API used to validate an instance of an analytic and return it.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Reset-Data-Analytic

URI: https://virtualdreamchat.com/rest/api/reset-data-analytic
Operation: POST
Type: XML
The rest-data-analytic API used to rest the data of a selected 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://virtualdreamchat.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://virtualdreamchat.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>





You can call any of the above API using JSON instead of XML using the endpoint /rest/json instead of /rest/api.



See Also

Browse
Sign In
Sign Up
Browse
Search
Create
Bots
Avatars
Scripts
Forums
Live Chat
Graphics
Workspaces
Chat Bot Wars
Users
Help
Help
News
Docs
User Manual
Search
API
API Console
SDK
Info
About
Contact
Terms
Privacy
Attribution
Links
Features
Apps
BotLibre.com