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.
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. |
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. |
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-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 | Choose a script and save for a bot. |
/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/delete-instance | POST | XML | Delete 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 |
URL | Operation | Type | Description |
---|---|---|---|
/rest/api/get-channel-bot-mode | POST | XML | Get channel bot mode. |
/rest/api/save-channel-bot-mode | POST | XML | Save channel bot mode. |
/rest/api/create-channel-attachment | POST | XML | Create a channel attachmemt |
/rest/api/create-channel | POST | XML | Create channel. |
/rest/api/update-channel | POST | XML | Update channel. |
/rest/api/get-bot-channel | POST | XML | Get bot channel. |
/rest/api/get-user-channel | POST | XML | Get user channel. |
/rest/api/get-channels | POST | XML | Retrieve all channels. |
/rest/api/get-channel-users | POST | XML | Get all users of a selected channel. |
/rest/api/get-channel-admins | POST | XML | Get all admins of a channel. |
/rest/api/update-channel-icon | POST | XML | Update the icon of the channel. |
/rest/api/thumbs-up-channel | POST | XML | Thumbs up a channel. |
/rest/api/thumbs-down-channel | POST | XML | Thumbs down a channel. |
/rest/api/flag-channel | POST | XML | Flag a channel. |
/rest/api/star-channel | POST | XML | Star a channel channel. |
/rest/api/delete-channel | POST | XML | Delete channel. |
/rest/api/check-channel | POST | XML | Check to validate and returns a channel. |
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. |
URL | Operation | Type | Description |
---|---|---|---|
/rest/api/get-scripts | POST | XML | Retrieve the scripts. |
/rest/api/get-script-users | POST | XML | Get users of a script. |
/rest/api/get-script-admins | POST | XML | Get admins of a script. |
/rest/api/create-script | POST | XML | Create a new script. |
/rest/api/update-script | POST | XML | Update the contents of the script. |
/rest/api/update-script-icon | POST | XML | Update the icon of the script. |
/rest/api/check-script | POST | XML | Check to validate and returns a script. |
/rest/api/delete-script | POST | XML | Delete a script. |
/rest/api/flag-script | POST | XML | Flag a script. |
/rest/api/thumbs-up-script | POST | XML | Placing a thumbs up to a script. |
/rest/api/thumbs-down-script | POST | XML | Placing a thumbs down to a script. |
/rest/api/star-script | POST | XML | Placing a star to a script. |
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/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 | Avatar Message. |
/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. |
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. |
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. |
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. |
URI: https://www.botlibre.biz/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.
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. |
URI: https://www.botlibre.biz/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.
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. |
URI: https://www.botlibre.biz/rest/json/chat
Operation: POST
Type: JSON
Parameter | Required | Type | Description |
---|
URI: https://www.botlibre.biz/rest/api/form-check-user
Operation: GET
Type: Form
The form-check-user API validates user, and returns the user's details.
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. |
URI: https://www.botlibre.biz/rest/api/check-user
Operation: POST
Type: XML
The check-user API validates user, and returns the user's details.
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. |
URI: https://www.botlibre.biz/rest/api/get-bots
Operation: POST
Type: XML
The get-bots API used to retrieve all availabel bots.
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 | attribute | Filter all the private bot items. | |
type | attribute | Type of bot. | |
typeFilter | attribute | Filter type of bot. | |
userFilter | attribute | Filter by users. | |
tag | attribute | Filter by tag. | |
category | attribute | Filter by category. | |
filter | attribute | Filter by name or description keywords. | |
contentRating | attribute | Filter by content rating. | |
restrict | attribute | Filter restriction. | |
sort | attribute | Sort condition. | |
page | attribute | Result page. |
URI: https://www.botlibre.biz/rest/api/get-bot-script-source
Operation: POST
Type: XML
The get-bot-script-source API used to get the source of the script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. | |
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. | |
instance | attribute | The ID of the bot. |
URI: https://www.botlibre.biz/rest/api/delete-bot-script
Operation: POST
Type: XML
The delete-bot-script API used to delete a script from a bot.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
instance | attribute | The ID of the bot. |
URI: https://www.botlibre.biz/rest/api/import-bot-script
Operation: POST
Type: XML
The import-bot-script API used to import a script to a bot.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. | |
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. | |
instance | attribute | The ID of the bot. |
URI: https://www.botlibre.biz/rest/api/import-bot-log
Operation: POST
Type: XML
The import-bot-log API used to import logs of a bot.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. | |
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. | |
instance | attribute | The ID of the bot. |
URI: https://www.botlibre.biz/rest/api/save-bot-avatar
Operation: POST
Type: XML
The save-bot-avatar API used to choose an avatar and save for a bot.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. | |
id | attribute | Bot's ID. | |
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. | |
instanceAvatar | attribute | Instance avatar. |
URI: https://www.botlibre.biz/rest/api/save-bot-script-source
Operation: POST
Type: XML
The save-bot-script-source API used to choose a script and save for a bot.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Scripts's ID. | |
source | Script source code to update. | ||
user | attribute | The ID of the user performing the operation. 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. | |
instance | attribute | The ID of the bot. |
URI: https://www.botlibre.biz/rest/api/create-bot-attachment
Operation: POST
Type: XML
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user perforing the operation. 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. | |
instance | attribute | The ID of the bot. | |
name | attribute | Attachment name. | |
type | attribute | Attachment type. | |
file | file | Bot attachment file. |
URI: https://www.botlibre.biz/rest/api/up-bot-script
Operation: POST
Type: XML
The up-bot-script API used to move the bot script up.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. | |
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. | |
instance | attribute | The ID of the bot. |
URI: https://www.botlibre.biz/rest/api/down-bot-script
Operation: POST
Type: XML
The down-bot-script API used to move down the bot script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. | |
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. | |
instance | attribute | The ID of the bot. |
URI: https://www.botlibre.biz/rest/api/get-instances
Operation: POST
Type: XML
The get-instances API will retrieve all the available instances.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. | |
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 instance items. | ||
type | Type of instance. | ||
typeFilter | Filter type of instance. | ||
userFilter | Filter by user. | ||
tag | Filter by tag. | ||
category | Filter by category. | ||
contentRating | Filter by content rating. | ||
restrict | Filter restriction. | ||
sort | Sort condition. | ||
page | attribute | Result page. |
URI: https://www.botlibre.biz/rest/api/get-instance-users
Operation: POST
Type: XML
The get-instance-users API will retrieve all users of that bot instance.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
user | attribute | The ID of the user performing the operation. | |
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. |
URI: https://www.botlibre.biz/rest/api/get-instance-admins
Operation: POST
Type: XML
The get-instance-admins API will retrieve all admins of that bot instance.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
user | attribute | The ID of the user performing the operation. | |
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. |
URI: https://www.botlibre.biz/rest/api/get-all-instances
Operation: POST
Type: XML
The form-get-all-instances API queries the details for all bot instances.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. | |
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 instance items. | ||
type | Type of instance. | ||
typeFilter | Filter type of instance. | ||
userFilter | Filter by user. | ||
tag | Filter by tag. | ||
category | Filter by category. | ||
contentRating | Filter by content rating. | ||
restrict | Filter restriction. | ||
sort | Sort condition. | ||
page | attribute | Result page. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
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. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
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. |
URI: https://www.botlibre.biz/rest/api/form-get-all-instances
Operation: GET
Type: Form
The form-get-all-instances API queries the details for all bot instances.
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. |
URI: https://www.botlibre.biz/rest/api/update-instance
Operation: POST
Type: XML
The update-instance API can let the user updates all contents of the selected bot instance
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user. The user must be registered with Bot Libre. | |
id | attribute | Bot's ID. | |
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. | |
domain | attribute | Domain. | |
allowForking | attribute | Allow forking. | |
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. | ||
subdomain | You can choose a subdomain to host your 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). | |
creator | attribute | Instance creator. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
file | file | The icon image file |
URI: https://www.botlibre.biz/rest/api/create-instance
Operation: POST
Type: XML
The create-instance API to create a new bot instance.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user. The user must be registered with Bot Libre. | |
template | Id or alias of bot to use as the template. | ||
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. | |
domain | attribute | Domain. | |
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). |
URI: https://www.botlibre.biz/rest/api/delete-instance
Operation: POST
Type: XML
The delete-instance API to delete a bot instance.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/flag-instance
Operation: POST
Type: XML
The flag-instance API Flag a bot instance.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
user | attribute | The ID of the user who performing the operation. 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. | |
flaggedReason | element | Flagged Reason. |
URI: https://www.botlibre.biz/rest/api/star-instance
Operation: POST
Type: XML
The star-instance API star a bot instance.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
stars | attribute | Stars. |
URI: https://www.botlibre.biz/rest/api/train-instance
Operation: POST
Type: XML
The train-instance API train a chat bot instance.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the opertaion. 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. | |
instance | attribute | The ID of the bot. | |
operation | attribute | The training operation, one of AddGreeting, RemoveGreeting, AddDefaultResponse, RemoveDefaultResponse, AddResponse. | |
question | element | The training question text. | |
response | element | The training response text. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/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
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-channel-bot-mode
Operation: POST
Type: XML
The get-channel-bot-mode API used get channel bot mode.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user who is getting the channel of the bot. 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. 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. |
URI: https://www.botlibre.biz/rest/api/save-channel-bot-mode
Operation: POST
Type: XML
The save-channel-bot-mode API used to save channel bot mode.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
instance | attribute | The ID of the channel. | |
user | attribute | The ID of the user who is saving the channel of the bot. 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. | |
token | attribute | The token of the user. A token can be obtained through check-user, and is valid until reset. | |
bot | attribute | The instance of the Bot. | |
mode | attribute | The mode of the Bot. |
URI: https://www.botlibre.biz/rest/api/create-channel-attachment
Operation: POST
Type: XML
The create-channel-attachment API used create an attachment for a channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user creating the channel attachment. The user must be registered with Bot Libre. | |
password | attribute | The password of the user who is creating the channel attachment. | |
token | attribute | The token of the user. A token can be obtained through check-user, and is valid until reset. | |
instance | attribute | The ID of the channel. | |
name | attribute | Attachment name. | |
type | attribute | Attachment type. | |
file | file | Channel attachment file. |
URI: https://www.botlibre.biz/rest/api/create-channel
Operation: POST
Type: XML
The create-channel API used to create a new channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user creating the channel. The user must be registered with Bot Libre. | |
password | attribute | The password of the user who is creating the channel. | |
token | attribute | The token of the user. A token can be obtained through check-user, and is valid until reset. | |
subdomain | attribute | Subdomain. | |
name | attribute | The channel name that used to identify the channel. | |
type | attribute | Channel type. | |
description | element | Brief description for the channel. | |
details | element | Details for the channel. | |
disclaimer | element | Disclaimer regarding the new channel. | |
license | element | License to release the channel and all its content under. | |
website | element | URL for the channel if it has it's own website. | |
categories | element | On what category would you place your channel. Must select at least one of the categories. (Bots, Bot Libre, Misc). | |
tags | element | Tags for your channel | |
isPrivate | attribute | Channel can be private, and accessed only by the user. | |
isHidden | attribute | Hidden channel will not be available to public. | |
accessMode | attribute | Channel will be accessed by based on the following options (Everyone, Users, Members, Admin). | |
videoAccessMode | attribute | Video access mode. | |
contentRating | attribute | Channel can be viewed or rated for (Everyone, Teen, Mature). | |
audioAccessMode | attribute | Audio access mode. | |
inviteAccessMode | attribute | Invite access mode. |
URI: https://www.botlibre.biz/rest/api/update-channel
Operation: POST
Type: XML
The update-channel API used to update an existing channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | The ID of the channel. | |
user | attribute | The ID of the user updating the channel. The user must be registered with Bot Libre. | |
password | attribute | The password of the user who is updating the channel. | |
token | attribute | The token of the user. A token can be obtained through check-user, and is valid until reset. | |
domain | attribute | Channel Domain. | |
name | attribute | The channel name that used to identify the channel. | |
type | attribute | Channel type. | |
description | element | Brief description for the channel. | |
details | element | Details for the channel. | |
disclaimer | element | Disclaimer regarding the new channel. | |
license | element | License to release the channel and all its content under. | |
website | element | URL for the channel if it has it's own website. | |
categories | element | On what category would you place your channel. Must select at least one of the categories. (Bots, Bot Libre, Misc). | |
tags | element | Tags for your channel | |
isPrivate | attribute | Channel can be private, and accessed only by the user. | |
isHidden | attribute | Hidden channel will not be available to public. | |
accessMode | attribute | Channel will be accessed by based on the following options (Everyone, Users, Members, Admin). | |
videoAccessMode | attribute | Video access mode. | |
contentRating | attribute | Channel can be viewed or rated for (Everyone, Teen, Mature). | |
audioAccessMode | attribute | Audio access mode. | |
inviteAccessMode | attribute | Invite access mode. |
URI: https://www.botlibre.biz/rest/api/get-bot-channel
Operation: POST
Type: XML
The get-bot-channel API used to get the channel of the bot.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Bot id for validation. | |
user | attribute | The ID of the user getting the channel of the bot. | |
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. | |
channelType | attribute | Channel type. |
URI: https://www.botlibre.biz/rest/api/get-user-channel
Operation: POST
Type: XML
The get-user-channel API used to get user channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user who's channel to get. | |
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. | |
channelType | attribute | Channel type. |
URI: https://www.botlibre.biz/rest/api/get-channels
Operation: POST
Type: XML
The get-channels API used to retrieve all available channels.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user who is retrieving all the channels. 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 channel items. | ||
filterAdult | Filter all adult channel items. | ||
type | Type of channel. | ||
typeFilter | Filter type of channel. | ||
userFilter | Filter by users. | ||
tag | attribute | Filter by tag. | |
category | attribute | Filter by category. | |
filter | attribute | Filter by name or description keywords. | |
contentRating | attribute | Filter by content rating. | |
restrict | attribute | Filter restriction. | |
sort | attribute | Sort condition. | |
page | attribute | Result page. |
URI: https://www.botlibre.biz/rest/api/get-channel-users
Operation: POST
Type: XML
The get-channel-users API used to return all users of a selected channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-channel-admins
Operation: POST
Type: XML
The get-channel-admins API used to returns all admins of a selected channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user who is getting all the admins of the channel. 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. |
URI: https://www.botlibre.biz/rest/api/update-channel-icon
Operation: POST
Type: XML
The update-channel-icon API used to update the icon of the channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user who is updating the icon of the channel. 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. | |
file | file | Icon |
URI: https://www.botlibre.biz/rest/api/thumbs-up-channel
Operation: POST
Type: XML
The thumbs-up-channel API used to let users place a thumbs up to a channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user who is performing a thumbs up to a channel. 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. |
URI: https://www.botlibre.biz/rest/api/thumbs-down-channel
Operation: POST
Type: XML
The thumbs-up-channel API used to let users place a thumbs down to a channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user who is performing a thumbs down to a channel. 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. |
URI: https://www.botlibre.biz/rest/api/flag-channel
Operation: POST
Type: XML
The flag-channel API used to flag a channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user who is flagging a channel. 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. | |
flaggedReason | element | Flagged Reason. |
URI: https://www.botlibre.biz/rest/api/star-channel
Operation: POST
Type: XML
The star-channel API used to star a channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user who is favourite a channel. 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. | |
stars | attribute | Stars. |
URI: https://www.botlibre.biz/rest/api/delete-channel
Operation: POST
Type: XML
The delete-channel API used to delete a channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user who is deleting a channel. 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. |
URI: https://www.botlibre.biz/rest/api/check-channel
Operation: POST
Type: XML
The check-channel API used to validate and returns a channel.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Channel id for validation. | |
user | attribute | The ID of the user who is checking or validating a channel. 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. |
URI: https://www.botlibre.biz/rest/api/get-forums
Operation: POST
Type: XML
The get-forums API used to retrieve available forums.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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 | attribute | Filter all the private forums items. | |
type | attribute | Type of forums. | |
typeFilter | attribute | Filter type of forums. | |
userFilter | attribute | Filter by users. | |
tag | attribute | Filter by tag. | |
category | attribute | Filter by category. | |
filter | attribute | Filter by name or description keywords. | |
contentRating | attribute | Filter by content rating. | |
restrict | attribute | Filter restriction. | |
sort | attribute | Sort condition. | |
page | attribute | Result page. |
URI: https://www.botlibre.biz/rest/api/get-forum-posts
Operation: POST
Type: XML
The get-forum-posts API used to retrieve available posts of each forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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 | attribute | Filter all the private posts. | |
type | attribute | Type of forums. | |
typeFilter | attribute | Filter type of forum posts. | |
userFilter | attribute | Filter by users. | |
tag | attribute | Filter by tag. | |
category | attribute | Filter by category. | |
filter | attribute | Filter by name or description keywords. | |
contentRating | attribute | Filter by content rating. | |
restrict | attribute | Filter restriction. | |
sort | attribute | Sort condition. | |
page | attribute | Result page. |
URI: https://www.botlibre.biz/rest/api/get-forum-users
Operation: POST
Type: XML
The get-forum-users API used to retrieve users of each forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-forum-admins
Operation: POST
Type: XML
The get-forum-admins API used to retrieve admins of each forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/save-forum-bot-mode
Operation: POST
Type: XML
Parameter | Required | Type | Description |
---|
URI: https://www.botlibre.biz/rest/api/get-forum-bot-mode
Operation: POST
Type: XML
Parameter | Required | Type | Description |
---|
URI: https://www.botlibre.biz/rest/api/create-forum
Operation: POST
Type: XML
The create-forum API to create a new forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
domain | attribute | Domain. | |
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 | element | Brief description for the forum. | |
details | element | Details for the forum. | |
disclaimer | element | Disclaimer regarding the new forum. | |
license | element | License to release the forum and all its content under. | |
website | element | URL for the forum if it has it's own website. | |
categories | element | On what category would you place your forum. Must select at least one of the categories. (Bots, Bot Libre, Misc). | |
tags | element | 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). | |
replyAccessMode | attribute | Who can reply to a post in the forum. | |
postAccessMode | attribute | Who can post on the forum. |
URI: https://www.botlibre.biz/rest/api/create-forum-attachment
Operation: POST
Type: XML
The create-forum-attachment API to craete a forum that contains an attachment.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID | |
instance | Forum's ID. | ||
user | attribute | The ID of the user performing the operation. 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. | |
file | Forum file. | ||
name | Attachment name. | ||
type | Attachment type. |
URI: https://www.botlibre.biz/rest/api/create-forum-post
Operation: POST
Type: XML
The create-forum-post API to create a new post for a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID | |
user | attribute | The ID of the user performing the operation. 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 | ||
forum | attribute | The forum. | |
details | Type of a markup | ||
tags | Tags | ||
subscribe | boolean | Subscribe to this post to be notified once a reply is posted |
URI: https://www.botlibre.biz/rest/api/update-forum
Operation: POST
Type: XML
The update-forum API used to update the contents of the forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. The user must be registered with Bot Libre. | |
id | attribute | Forum's ID. | |
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. | |
domain | attribute | Domain. | |
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. | |
creator | attribute | Instance creator. | |
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). | |
replyAccessMode | attribute | Who can reply to a post in the forum. | |
postAccessMode | attribute | Who can post on the forum. |
URI: https://www.botlibre.biz/rest/api/update-forum-post
Operation: POST
Type: XML
The update-forum-post API updates the content of a post of a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
replies | Post replies. | ||
isFeatured | attribute | Featured forum. | |
topic | Post's topic | ||
details | Post's text content | ||
tags | Post's tags, csv |
URI: https://www.botlibre.biz/rest/api/update-forum-icon
Operation: POST
Type: XML
THe update-forum-icon API used to change the icon of the fourm.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
file | file | Icon image file. |
URI: https://www.botlibre.biz/rest/api/check-forum
Operation: POST
Type: XML
The check-forum API validate and returns a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/delete-forum
Operation: POST
Type: XML
The delete-forum API to delete a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/delete-forum-post
Operation: POST
Type: XML
The delete-forum-post API delete's a post of a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/flag-forum
Operation: POST
Type: XML
The flag-forum API used to flag a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
flaggedReason | element | Flagged Reason. |
URI: https://www.botlibre.biz/rest/api/flag-forum-post
Operation: POST
Type: XML
The flag-forum-post API flag's a post of a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
flaggedReason | element | Flagged Reason. |
URI: https://www.botlibre.biz/rest/api/thumbs-up-forum
Operation: POST
Type: XML
The thumbs-up-forum API used to place a thumbs up to a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/thumbs-down-forum
Operation: POST
Type: XML
The thumbs-down-forum API used to place thumbs down to a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | TThe ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/subscribe-forum
Operation: POST
Type: XML
The subscribe-forum API is to let a user subscribe to a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/unsubscribe-forum
Operation: POST
Type: XML
The unsubscribe-forum API is to let the user unsubscribe to a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/star-forum
Operation: POST
Type: XML
The star-forum API is to let a user place a star to a forum.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Forum's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
stars | attribute | Stars. |
URI: https://www.botlibre.biz/rest/api/get-scripts
Operation: POST
Type: XML
The get-scripts API used to retrieve available scripts.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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 script items. | ||
filterAdult | Filter all adult script items. | ||
type | Type of script. | ||
typeFilter | Filter type of script. | ||
userFilter | Filter by users. | ||
tag | attribute | Filter by tag. | |
category | attribute | Filter by category. | |
filter | attribute | Filter by name or description keywords. | |
contentRating | attribute | Filter by content rating. | |
restrict | attribute | Filter restriction. | |
sort | attribute | Sort condition. | |
page | attribute | Result page. |
URI: https://www.botlibre.biz/rest/api/get-script-users
Operation: POST
Type: XML
The get-script-users API used to retrieve users of a script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-script-admins
Operation: POST
Type: XML
The get-script-admins API is to retrieve all admins of a script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/create-script
Operation: POST
Type: XML
The create-script API is used to create a new script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
domain | attribute | Domain. | |
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). |
URI: https://www.botlibre.biz/rest/api/update-script
Operation: POST
Type: XML
The update-script API used to update the contents of the script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. The user must be registered with Bot Libre. | |
password | attribute | The password of the user who is creating the script. | |
token | attribute | The token of the user. A token can be obtained through check-user, and is valid until reset. | |
domain | attribute | Domain. | |
name | attribute | The script name that used to identify the script. | |
alias | attribute | Another name can be used for the new forum to be identified. | |
description | Brief description for the forum. | ||
details | Details for the script. | ||
disclaimer | Disclaimer regarding the new script. | ||
license | License to release the script and all its content under. | ||
website | URL for the forum if it has it's own website. | ||
subdomain | attribute | You can choose a subdomain to host your script'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 script. Must select at least one of the categories. (Bots, Bot Libre, Misc). | ||
tags | Tags for your script | ||
isPrivate | attribute | Scripts can be private, and accessed only by the user. | |
isHidden | attribute | Hidden forum will not be available to public. | |
accessMode | attribute | Script will be accessed by based on the following options (Everyone, Users, Members, Admin). | |
forkAccessMode | attribute | Script will be able to copy by based on the following options (Everyone, Users, Members, Admin). | |
contentRating | attribute | Script can be viewed or rated for (Everyone, Teen, Mature). | |
creator | attribute | Script creator. |
URI: https://www.botlibre.biz/rest/api/update-script-icon
Operation: POST
Type: XML
THe update-script-icon API used to change the icon of the script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
file | file | Icon image file. |
URI: https://www.botlibre.biz/rest/api/check-script
Operation: POST
Type: XML
The check-forum API validate and returns a script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/delete-script
Operation: POST
Type: XML
The delete-script API to delete a script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/flag-script
Operation: POST
Type: XML
The flag-script API used to flag a script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/thumbs-up-script
Operation: POST
Type: XML
The thumbs-up-forum API used to place a thumbs up to a script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/thumbs-down-script
Operation: POST
Type: XML
The thumbs-down-forum API used to place thumbs down to a script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/star-script
Operation: POST
Type: XML
The star-forum API is to let a user place a star to a script.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Script's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-avatars
Operation: POST
Type: XML
THe get-avatars API is used to retrieve available avatars.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | ||
tag | attribute | Filter by tag. | |
category | attribute | Filter by category. | |
filter | attribute | Filter by name or description keywords. | |
contentRating | attribute | Filter by content rating. | |
restrict | attribute | Filter restriction. | |
sort | attribute | Sort condition. | |
page | attribute | Result page. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-avatar-admins
Operation: POST
Type: XML
The get-avatar-admins API used to retrieve all admins of a selected avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-avatar-media
Operation: POST
Type: XML
The get-avatar-media API used to retrieve the media of an avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/create-avatar
Operation: POST
Type: XML
The create-avatar API used to create a new avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
domain | attribute | Domain. | |
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 | element | Brief description for the avatar. | |
details | element | Details for the avatar. | |
disclaimer | element | Disclaimer regarding the new avatar. | |
license | element | License to release the avatar and all its content under. | |
website | element | URL for the avatar if it has it's own website. | |
categories | element | On what category would you place your avatar. Must select at least one of the categories. (People, 3D, Video, MP4). | |
tags | attribute | 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). |
URI: https://www.botlibre.biz/rest/api/create-avatar-media
Operation: POST
Type: XML
The create-avatar-media API used to create a media for an avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
instance | attribute | The ID of the avatar. | |
name | attribute | Name of the media file. | |
type | attribute | Type of the avatar media file. | |
file | file | Media file. |
URI: https://www.botlibre.biz/rest/api/save-avatar-media
Operation: POST
Type: XML
The save-avatar-media API used to save the changes current media of an avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
mediaId | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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 | attribute | Domain. | |
instance | attribute | The ID of the avatar. | |
name | attribute | Name of the media. | |
type | attribute | Type of the avatar media. | |
emotions | attribute | Emotions of the avatar. | |
actions | attribute | Actions of the avatar. | |
poses | attribute | Poses of the avatar. | |
hd | attribute | HD type of media. | |
talking | attribute | Talking state of the avatar. |
URI: https://www.botlibre.biz/rest/api/save-avatar-background
Operation: POST
Type: XML
The save-avatar-background API saves the background image of an avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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 | attribute | Domain. | |
instance | attribute | The ID of the avatar. | |
name | attribute | Name of the media file. | |
type | attribute | Type of the avatar media file. | |
file | file | Background image file. |
URI: https://www.botlibre.biz/rest/api/delete-avatar
Operation: POST
Type: XML
The delete-avatar API used to delete a selected avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/delete-avatar-media
Operation: POST
Type: XML
The delete-avatar-media API used to delete a media of an avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
mediaId | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
instance | attribute | The ID of the avatar. |
URI: https://www.botlibre.biz/rest/api/delete-avatar-background
Operation: POST
Type: XML
The delete-avatar-background API used to delete a background image of an avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/check-avatar
Operation: POST
Type: XML
The check-avatar API is used to validate and return the avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/avatar-message
Operation: POST
Type: XML
The avatar-message API
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. | |
password | attribute | 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 | element | Message. | |
avatar | attribute | Avatar id. | |
avatar | attribute | The avatar. | |
emote | attribute | The emote for the message. | |
action | attribute | The actoin for the message. | |
pose | attribute | The pose for the message. | |
speak | attribute | Speak. | |
voice | attribute | Voice used for the message. | |
voiceMode | attribute | Voice mode for the message. | |
format | attribute | Message format. | |
hd | attribute | HD. |
URI: https://www.botlibre.biz/rest/api/star-avatar
Operation: POST
Type: XML
The star-avatar API used for the user to star an avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
stars | attribute | Stars. |
URI: https://www.botlibre.biz/rest/api/flag-avatar
Operation: POST
Type: XML
The flag-avatar API used to flag an avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
flaggedReason | element | Flagged Reason. |
URI: https://www.botlibre.biz/rest/api/init-avatar
Operation: POST
Type: XML
Parameter | Required | Type | Description |
---|
URI: https://www.botlibre.biz/rest/api/update-avatar
Operation: POST
Type: XML
The update-avatar API used to update and change the content of an avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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 | attribute | Domain. | |
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 | element | Brief description for the avatar. | |
details | element | Details for the avatar. | |
disclaimer | element | Disclaimer regarding the new avatar. | |
license | element | License to release the avatar and all its content under. | |
website | element | URL for the avatar if it has it's own website. | |
categories | element | On what category would you place your avatar. Must select at least one of the categories. (People, 3D, Video, MP4). | |
tags | element | 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). | |
isFeatured | attribute | Featured instance. | |
creator | attribute | Instance creator. |
URI: https://www.botlibre.biz/rest/api/update-avatar-icon
Operation: POST
Type: XML
The update-avatar-icon API used to update the avatar's icon
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
file | file | Icon image file. |
URI: https://www.botlibre.biz/rest/api/thumbs-up-avatar
Operation: POST
Type: XML
The thumbs-up-avatar API used to place a thumbs up on a selected avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/thumbs-down-avatar
Operation: POST
Type: XML
The thumbs-down-avatar API used to place a thumbs down to a selected avatar.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Avatar's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-domains
Operation: POST
Type: XML
The get-domains API used to retrieve all available domains.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | ||
tag | attribute | Filter by tag. | |
category | attribute | Filter by category. | |
filter | attribute | Filter by name or description keywords. | |
contentRating | attribute | Filter by content rating. | |
restrict | attribute | Filter restriction. | |
sort | attribute | Sort condition. | |
page | attribute | Result page. |
URI: https://www.botlibre.biz/rest/api/get-domain-users
Operation: POST
Type: XML
The get-domain-users API used to retrieve all users of a domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-domain-admins
Operation: POST
Type: XML
The get-domain-admins API used to retrieve all admins of a domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-domain
Operation: POST
Type: XML
The get-domain API retrieve a selected domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-domain-icon
Operation: POST
Type: XML
The get-domain-icon API used to return an icon of a domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/create-domain
Operation: POST
Type: XML
The create-domain API create's a new domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | ||
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). | |
creationMode | attribute | Who can create channels, forums, bots in this domain. |
URI: https://www.botlibre.biz/rest/api/check-domain
Operation: POST
Type: XML
The check-domain API used to validate and return a domain back.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/update-domain
Operation: POST
Type: XML
The update-domain API updates the contents of the domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. | ||
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). | |
creator | attribute | Instance creator. | |
creationMode | Who can create channels, forums, bots in this domain. |
URI: https://www.botlibre.biz/rest/api/delete-domain
Operation: POST
Type: XML
The delete-domain API delete a selected domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/flag-domain
Operation: POST
Type: XML
The flag-domain API used to flag a Domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
flaggedReason | element | Flagged Reason. |
URI: https://www.botlibre.biz/rest/api/star-domain
Operation: POST
Type: XML
The star-domain API used to place a star to a domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
stars | attribute | Stars. |
URI: https://www.botlibre.biz/rest/api/thumbs-up-domain
Operation: POST
Type: XML
The thumbs-up-domain API used to thumbs up a domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/thumbs-down-domain
Operation: POST
Type: XML
The thumbs-down-domain API used to thumbs down to a selected domain.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Domain's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-graphics
Operation: POST
Type: XML
The get-graphics API retrieve all available graphics.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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 graphic items. | ||
type | Type of graphic. | ||
typeFilter | Filter type of graphic. | ||
userFilter | Filter by users. | ||
tag | attribute | Filter by tag. | |
category | attribute | Filter by category. | |
filter | attribute | Filter by name or description keywords. | |
contentRating | attribute | Filter by content rating. | |
restrict | attribute | Filter restriction. | |
sort | attribute | Sort condition. | |
page | attribute | Result page. |
URI: https://www.botlibre.biz/rest/api/get-graphic-users
Operation: POST
Type: XML
The get-graphic-users API return all users of a selected graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Graphic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-graphic-admins
Operation: POST
Type: XML
The get-graphic-admins API returns all admins of a selected graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Graphic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/update-graphic
Operation: POST
Type: XML
The update-graphic API used to update the contents of a graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | Graphic's ID. | ||
user | attribute | The ID of the user performing the operation. The user must be registered with Bot Libre. | |
password | attribute | The password of the user who is updating the graphic. | |
token | attribute | The token of the user. A token can be obtained through check-user, and is valid until reset. | |
domain | attribute | Domain. | |
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 | element | Brief description for the graphic. | |
details | element | Details for the graphic. | |
disclaimer | element | Disclaimer regarding the new graphic. | |
license | element | License to release the graphic and all its content under. | |
website | element | URL for the graphic if it has it's own website. | |
categories | element | On what category would you place your graphic. Must select at least one of the categories. (Image, Audio, Data, Misc). | |
tags | element | 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). | |
contentRating | attribute | Graphic can be viewed or rated for (Everyone, Teen, Mature). | |
isFeatured | attribute | Featured instance. | |
creator | attribute | Instance creator. |
URI: https://www.botlibre.biz/rest/api/update-graphic-icon
Operation: POST
Type: XML
The update-graphic-icon API used to change and update the graphic icon.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Graphic's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
file | file | Icon image file. |
URI: https://www.botlibre.biz/rest/api/update-graphic-media
Operation: POST
Type: XML
The update-graphic-media API used to update the media content of the selected graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. The user must be registered with Bot Libre. | |
id | attribute | Graphic's ID. | |
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. | |
fileName | attribute | File name of the graphic. | |
fileType | attribute | File type of the graphic. | |
file | file | Graphic file. |
URI: https://www.botlibre.biz/rest/api/create-graphic
Operation: POST
Type: XML
The create-graphic API used to create a new graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
domain | attribute | Domain. | |
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 | element | Brief description for the graphic. | |
details | element | Details for the graphic. | |
disclaimer | element | Disclaimer regarding the new graphic. | |
license | element | License to release the graphic and all its content under. | |
website | element | URL for the graphic if it has it's own website. | |
categories | element | On what category would you place your graphic. Must select at least one of the categories. (Bot Libre, Web, Education, Misc). | |
tags | element | 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). |
URI: https://www.botlibre.biz/rest/api/delete-graphic
Operation: POST
Type: XML
The delete-graphic API used to delete a selected graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Graphic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/check-graphic
Operation: POST
Type: XML
The check-graphic API used to validate a graphic and return it back.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Graphic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/flag-graphic
Operation: POST
Type: XML
The flag-graphic API used to flag a graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Graphic's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
flaggedReason | element | Flagged Reason. |
URI: https://www.botlibre.biz/rest/api/star-graphic
Operation: POST
Type: XML
The star-graphic API used to place a star to a graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Graphic's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
stars | attribute | Stars. |
URI: https://www.botlibre.biz/rest/api/thumbs-up-graphic
Operation: POST
Type: XML
The thumbs-up-graphic API used to place a thumbs up on a selected graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Graphic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/thumbs-down-graphic
Operation: POST
Type: XML
The thumbs-down-graphic API used to place a thumbs down to a selected graphic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Graphic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-analytics
Operation: POST
Type: XML
The get-analytics API used to retrieve all avaiable analytics.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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 | attribute | Filter all the private analytic items. | |
filterAdult | attribute | Filter all adult analytic items. | |
type | attribute | Type of analytics. | |
typeFilter | attribute | Filter type of analytic. | |
userFilter | attribute | Filter by users. | |
tag | attribute | Filter by tag. | |
category | attribute | Filter by category. | |
filter | attribute | Filter by name or description keywords. | |
contentRating | attribute | Filter by content rating. | |
restrict | attribute | Filter restriction. | |
sort | attribute | Sort condition. | |
page | attribute | Result page. |
URI: https://www.botlibre.biz/rest/api/get-analytic-users
Operation: POST
Type: XML
The get-analytic-users API used to retrieve all users of an analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-analytic-admins
Operation: POST
Type: XML
The get-analytic-admins API used to retrieve all admins of a selected analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/test-analytic
Operation: POST
Type: XML
The test-analytic API used to test a trained analytic model with a specific instructions.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
file | file | The image as input to be recognized. |
URI: https://www.botlibre.biz/rest/api/test-audio-analytic
Operation: POST
Type: XML
The test-audio-analytic API used to test an audio model analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
file | file | Audio file needed to audio recognize. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
instance | attribute | The ID of the Analytic. | |
file | file | Image to test for the object detection analytic. |
URI: https://www.botlibre.biz/rest/api/get-test-media-result
Operation: POST
Type: XML
The get-test-media-result API retrieve test media results.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/report-media-analytic
Operation: POST
Type: XML
The report-media-analytic API used to get an analytic reprot.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
processingTestMediaStatus | attribute | Analytic test media status. |
URI: https://www.botlibre.biz/rest/api/train-analytic
Operation: POST
Type: XML
The train-analytic API used to train an analytic model.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
trainingStatus | attribute | Analytic training status. | |
cycles | attribute | Analytic training cycles. |
URI: https://www.botlibre.biz/rest/api/delete-analytic-media
Operation: POST
Type: XML
The delete-analytic-media API used to delete a select analytic media.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
mediaId | attribute | Analytic's media ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
label | attribute | Analytic label. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
mediaId | attribute | Analytic's media ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
label | attribute | Analytic label. |
URI: https://www.botlibre.biz/rest/api/get-analytic-media
Operation: POST
Type: XML
The get-analytic-media API used to retrieve all analytic media.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic id for validation. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/get-analytic-test-media
Operation: POST
Type: XML
The get-analytic-test-media API retrieve a test media of an analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. | |
password | attribute | Password of the user. | |
token | attribute | The token of the user. A token can be obtained through check-user, and is valid until reset. | |
instance | attribute | Analytic's ID. | |
label | attribute | Analytic label. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. | |
password | attribute | 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 | attribute | Domain. | |
instance | attribute | Analytic's ID. | |
label | attribute | Analytic label. |
URI: https://www.botlibre.biz/rest/api/delete-analytic-label
Operation: POST
Type: XML
The delete-analytic-label API used to delete a selected label of an analytic object.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. | |
password | attribute | Password of the user. | |
token | attribute | The token of the user. A token can be obtained through check-user, and is valid until reset. | |
instance | attribute | Analytic's ID. | |
label | attribute | Analytic label. |
URI: https://www.botlibre.biz/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.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. | |
password | attribute | Password of the user. | |
token | attribute | The token of the user. A token can be obtained through check-user, and is valid until reset. | |
instance | attribute | Analytic's ID. | |
label | attribute | Analytic label. |
URI: https://www.botlibre.biz/rest/api/check-training
Operation: POST
Type: XML
The check-training API used to retrieve some information of the current training of a model.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. The user must be registered with Bot Libre. | |
id | attribute | Analytic's ID. | |
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. |
URI: https://www.botlibre.biz/rest/api/create-analytic
Operation: POST
Type: XML
The create-analytic API create a new Analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
domain | attribute | Domain. | |
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 | element | Brief description for the Analytic. | |
details | element | Details for the Analytic. | |
disclaimer | element | Disclaimer regarding the new Analytic. | |
license | element | License to release the Analytic and all its content under. | |
website | element | URL for the Analytic if it has it's own website. | |
categories | element | On what category would you place your Analytic. Must select at least one of the categories. (Image, Audio, Data, Misc). | |
tags | element | 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). | |
contentRating | attribute | Analytic can be viewed or rated for (Everyone, Teen, Mature). |
URI: https://www.botlibre.biz/rest/api/update-analytic
Operation: POST
Type: XML
The update-analytic API update or change the details of a selected analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. The user must be registered with Bot Libre. | |
id | attribute | Analytic's ID. | |
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. | |
domain | attribute | Domain. | |
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 | element | Brief description for the Analytic. | |
details | element | Details for the Analytic. | |
disclaimer | element | Disclaimer regarding the new Analytic. | |
license | element | License to release the Analytic and all its content under. | |
website | element | URL for the Analytic if it has it's own website. | |
categories | element | On what category would you place your Analytic. Must select at least one of the categories. (Image, Audio, Data, Misc). | |
tags | element | 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). | |
contentRating | attribute | Avatar can be viewed or rated for (Everyone, Teen, Mature). | |
isFeatured | attribute | Featured instance. | |
creator | attribute | Instance creator. |
URI: https://www.botlibre.biz/rest/api/flag-analytic
Operation: POST
Type: XML
The flag-analytic API used to place a flag to an Analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
flaggedReason | element | Flagged Reason. |
URI: https://www.botlibre.biz/rest/api/thumbs-up-analytic
Operation: POST
Type: XML
The thumbs-up-analytic API used to thumbs up an Analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
The thumbs-down-analytic API used to thumbs down to an Analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/star-analytic
Operation: POST
Type: XML
The star-analytic API is used to star an analytic object.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
stars | attribute | Stars. |
URI: https://www.botlibre.biz/rest/api/delete-analytic
Operation: POST
Type: XML
The delete-analyic API used to delete a selected analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
id | attribute | Analytic's ID. | |
user | attribute | The ID of the user performing the operation. 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. |
URI: https://www.botlibre.biz/rest/api/check-analytic
Operation: POST
Type: XML
The check-analytic API used to validate an instance of an analytic and return it.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
id | attribute | Analytic's ID. | |
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. |
URI: https://www.botlibre.biz/rest/api/reset-data-analytic
Operation: POST
Type: XML
The rest-data-analytic API used to rest the data of a selected analytic.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user performing the operation. 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. | |
id | attribute | Analytic's ID. | |
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. |
URI: https://www.botlibre.biz/rest/api/test-data-analytic
Operation: POST
Type: XML
Test the data analytic with one set of inputs.
Parameter | Required | Type | Description |
---|---|---|---|
application | attribute | Your application ID. | |
user | attribute | The ID of the user perfoming the operation. 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. | |
id | attribute | Analytic's ID. | |
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 trained as input. |
URI: https://www.botlibre.biz/rest/api/train-data-analytic
Operation: POST
Type: XML
Train the data analytic with multiple sets of inputs and outputs.
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. | |
instance | attribute | Analytic's ID. | |
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. |
You can call any of the above API using JSON instead of XML using the endpoint /rest/json instead of /rest/api.