Scaricare l'open source Bot Libre Community Edition e installare Bot Libre nel proprio server
Docs : Web API

Web API

Oltre ad essere in grado di incorporare la vostra chat bot sul tuo sito web, e l'accesso da qualsiasi dispositivo iOS o Android, è anche possibile accedere alla chat bot attraverso il Bot Libre web API. L'API web vi darà il vantaggio di avere il controllo completo del vostro bot interfaccia client.

È possibile utilizzare l'API web per accedere al tuo bot dal tuo sito web tramite JavaScript, PHP o qualsiasi altro linguaggio. È inoltre possibile utilizzare l'API web per creare la propria applicazione mobile per accedere al tuo bot, come Android o iOS applicazione.

Una web API, è un insieme di HTTP GET/POST URI che permette l'invio e la ricezione di dati del messaggio. Quando si visita un sito web, il browser fa una serie di HTTP GET/POST richieste di Uri che restituiscono il contenuto HTML. In un servizio web, gli indirizzi in notazione Uri ritorno XML o JSON dati, invece di contenuto HTML.

Il Bot Libre web API fornisce tre Api REST. La prima è un insieme di GET HTTP Uri che prendono FORMA i dati e restituzione di dati XML. Il secondo set di API di prendere POST HTTP, XML dei dati e restituzione di dati XML. Il terzo set di API di prendere POST HTTP, JSON dati e restituire dati in formato JSON.

La maggior parte delle applicazioni utilizzare XML POST API, ma in alcune applicazioni può scegliere di utilizzare il MODULO di OTTENERE API a causa della sua semplicità. Le Api sono identici tra di loro, a meccanismo.


Chat API URL Endpoint

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.

Utente API URL Endpoint

URL Operation Type Description
/rest/api/form-check-user GET Form Validates and returns the user's details.
/rest/api/check-user POST XML Validates and returns the user's details.

Bot API URL Endpoint

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

Endpoint URL dell'API Live Chat

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.

Forum API URL Endpoint

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

Script API URL Endpoint

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.

Avatar API URL Endpoint

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.

Dominio URL Endpoint

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.

Grafica URL Endpoint

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.

Endpoint URL di analisi

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

Chat API URL Endpoint

Form Chat

URI: https://www.botlibre.com/rest/api/form-chat
Operation: GET
Type: Form
Il modulo-chat API riceve un messaggio di chat e restituisce il bot di chat risposta come un documento XML.

Parameters

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

Esempio

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


Esempio Risultato

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


XML Chat

URI: https://www.botlibre.com/rest/api/chat
Operation: POST
Type: XML
La chat API riceve un messaggio di chat e restituisce il bot di chat risposta come un documento XML.

Parameters

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

Esempio

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


Esempio Risultato

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


JSON Chat

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

Parameters

Parameter Required Type Description




Utente API URL Endpoint

Form-Check-User

URI: https://www.botlibre.com/rest/api/form-check-user
Operation: GET
Type: Form
L'API form-check-user convalida l'utente e restituisce i dettagli dell'utente.

Parameters

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

Esempio

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


Esempio Risultato

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


Check-User

URI: https://www.botlibre.com/rest/api/check-user
Operation: POST
Type: XML
L'API check-user convalida l'utente e restituisce i dettagli dell'utente.

Parameters

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

Esempio

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


Esempio Risultato

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



Bot API URL Endpoint

Get-Bots

URI: https://www.botlibre.com/rest/api/get-bots
Operation: POST
Type: XML
L'API get-bots utilizzata per recuperare tutti i bot availabel.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
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.



Get-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/get-bot-script-source
Operation: POST
Type: XML
API get-bot-script-source utilizzata per ottenere l'origine dello script.

Parameters

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.



Delete-Bot-Script

URI: https://www.botlibre.com/rest/api/delete-bot-script
Operation: POST
Type: XML
API delete-bot-script utilizzata per eliminare uno script da un bot.

Parameters

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.



Import-Bot-Script

URI: https://www.botlibre.com/rest/api/import-bot-script
Operation: POST
Type: XML
API import-bot-script utilizzata per importare uno script in un bot.

Parameters

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.



Import-Bot-Log

URI: https://www.botlibre.com/rest/api/import-bot-log
Operation: POST
Type: XML
API import-bot-log utilizzata per importare i log di un bot.

Parameters

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.



Save-Bot-Avatar

URI: https://www.botlibre.com/rest/api/save-bot-avatar
Operation: POST
Type: XML
L'API save-bot-avatar utilizzata per scegliere un avatar e salvare per un bot.

Parameters

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.



Save-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/save-bot-script-source
Operation: POST
Type: XML
L'API save-bot-script-source usata per scegliere uno script e salvarlo per un bot.

Parameters

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.



Create-Bot-Attachment

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

Parameters

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.



Up-Bot-Script

URI: https://www.botlibre.com/rest/api/up-bot-script
Operation: POST
Type: XML
API up-bot-script utilizzata per spostare lo script bot verso l'alto.

Parameters

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.



Down-Bot-Script

URI: https://www.botlibre.com/rest/api/down-bot-script
Operation: POST
Type: XML
L'API down-bot-script utilizzata per spostarsi verso il basso nello script del bot.

Parameters

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.



Get-Instances

URI: https://www.botlibre.com/rest/api/get-instances
Operation: POST
Type: XML
L'API get-instances recupererà tutte le istanze disponibili.

Parameters

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.



Get-Instance-Users

URI: https://www.botlibre.com/rest/api/get-instance-users
Operation: POST
Type: XML
L'API get-instance-users recupererà tutti gli utenti di tale istanza bot.

Parameters

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.



Get-Instance-Admins

URI: https://www.botlibre.com/rest/api/get-instance-admins
Operation: POST
Type: XML
L'API get-instance-admins recupererà tutti gli amministratori di tale istanza del bot.

Parameters

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.



Get-All-Instances

URI: https://www.botlibre.com/rest/api/get-all-instances
Operation: POST
Type: XML
L'API form-get-all-instances esegue una query sui dettagli per tutte le istanze del bot.

Parameters

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.

Esempio

<browse application="1234567890"/>


Esempio Risultato

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


Check-Instance

URI: https://www.botlibre.com/rest/api/check-instance
Operation: POST
Type: XML
L'API dell'istanza di controllo convalida l'presenza di un ID bot o di un nome e restituisce i dettagli del bot.

Parameters

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.

Esempio

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


Esempio Risultato

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


Form-Check-Instance

URI: https://www.botlibre.com/rest/api/form-check-instance
Operation: GET
Type: Form
L'API form-check-instance convalida l'presenza di un ID bot o di un nome e restituisce i dettagli del bot.

Parameters

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.

Esempio

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


Esempio Risultato

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


Form-Get-All-Instances

URI: https://www.botlibre.com/rest/api/form-get-all-instances
Operation: GET
Type: Form
L'API form-get-all-instances esegue una query sui dettagli per tutte le istanze del bot.

Parameters

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

Esempio

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


Esempio Risultato

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


Update-Instance

URI: https://www.botlibre.com/rest/api/update-instance
Operation: POST
Type: XML
L'API dell'istanza di aggiornamento può consentire all'utente di aggiornare tutti i contenuti dell'istanza bot selezionata

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user. The user must be registered with Bot Libre.
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.



Update-Instance-Icon

URI: https://www.botlibre.com/rest/api/update-instance-icon
Operation: POST
Type: XML
L'API update-instance-icon consente all'utente di modificare l'icona dell'istanza del bot.

Parameters

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



Create-Instance

URI: https://www.botlibre.com/rest/api/create-instance
Operation: POST
Type: XML
API create-instance per creare una nuova istanza bot.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user. The user must be registered with Bot Libre.
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).



Delete-Instance

URI: https://www.botlibre.com/rest/api/delete-instance
Operation: POST
Type: XML
API dell'istanza di eliminazione per eliminare un'istanza del bot.

Parameters

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.



Flag-Instance

URI: https://www.botlibre.com/rest/api/flag-instance
Operation: POST
Type: XML
API flag-instance Contrassegna un'istanza bot.

Parameters

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.



Star-Instance

URI: https://www.botlibre.com/rest/api/star-instance
Operation: POST
Type: XML
L'API dell'istanza a stella è una stella di un'istanza bot.

Parameters

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.



Train-Instance

URI: https://www.botlibre.com/rest/api/train-instance
Operation: POST
Type: XML
L'API dell'istanza di treno addestra un'istanza di chat bot.

Parameters

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.



Thumbs-Up-Instance

URI: https://www.botlibre.com/rest/api/thumbs-up-instance
Operation: POST
Type: XML
L'API dell'istanza thumbs-up di un utente può posizionare un pollice in su in un'istanza del bot di chat.

Parameters

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.



Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-instance
Operation: POST
Type: XML
L'istanza thumbs-down-istanza che un utente può posizionare un pollice in giù in un'istanza del chat bot

Parameters

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.




Endpoint URL dell'API Live Chat

Get-Channel-Bot-Mode

URI: https://www.botlibre.com/rest/api/get-channel-bot-mode
Operation: POST
Type: XML
L'API get-channel-bot-mode utilizzata in modalità get channel bot.

Parameters

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.



Save Channel Bot Mode

URI: https://www.botlibre.com/rest/api/save-channel-bot-mode
Operation: POST
Type: XML
API save-channel-bot-mode utilizzata per salvare la modalità bot del canale.

Parameters

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.



Create channel attachment

URI: https://www.botlibre.com/rest/api/create-channel-attachment
Operation: POST
Type: XML
L'API create-channel-attachment utilizzata per creare un allegato per un canale.

Parameters

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.



Create Channel

URI: https://www.botlibre.com/rest/api/create-channel
Operation: POST
Type: XML
API di creazione del canale utilizzata per creare un nuovo canale.

Parameters

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.



Create Channel

URI: https://www.botlibre.com/rest/api/update-channel
Operation: POST
Type: XML
API del canale di aggiornamento utilizzata per aggiornare un canale esistente.

Parameters

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.



Get bot channel

URI: https://www.botlibre.com/rest/api/get-bot-channel
Operation: POST
Type: XML
L'API get-bot-channel usata per ottenere il canale del bot.

Parameters

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.



Get user channel

URI: https://www.botlibre.com/rest/api/get-user-channel
Operation: POST
Type: XML
API get-user-channel utilizzata per ottenere il canale utente.

Parameters

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.



Get Channels

URI: https://www.botlibre.com/rest/api/get-channels
Operation: POST
Type: XML
API get-channels utilizzata per recuperare tutti i canali disponibili.

Parameters

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.



Get channel users

URI: https://www.botlibre.com/rest/api/get-channel-users
Operation: POST
Type: XML
API get-channel-users utilizzata per restituire tutti gli utenti di un canale selezionato.

Parameters

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.



Get Channel Admins

URI: https://www.botlibre.com/rest/api/get-channel-admins
Operation: POST
Type: XML
L'API get-channel-admins utilizzata per restituire tutti gli amministratori di un canale selezionato.

Parameters

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.



Update Channel Icon

URI: https://www.botlibre.com/rest/api/update-channel-icon
Operation: POST
Type: XML
L'API update-channel-icon utilizzata per aggiornare l'icona del canale.

Parameters

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



Thumbs Up Channel

URI: https://www.botlibre.com/rest/api/thumbs-up-channel
Operation: POST
Type: XML
L'API thumbs-up-channel utilizzata per consentire agli utenti di posizionare un pollice in su su un canale.

Parameters

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.



Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-channel
Operation: POST
Type: XML
L'API pollice in su del canale utilizzata per consentire agli utenti di posizionare un pollice verso il basso su un canale.

Parameters

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.



Flag-Channel

URI: https://www.botlibre.com/rest/api/flag-channel
Operation: POST
Type: XML
API del canale di flag utilizzata per contrassegnare un canale.

Parameters

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.



Star-Channel

URI: https://www.botlibre.com/rest/api/star-channel
Operation: POST
Type: XML
L'API star-channel utilizzata per contrassegnare un canale.

Parameters

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.



Delete-Channel

URI: https://www.botlibre.com/rest/api/delete-channel
Operation: POST
Type: XML
API del canale di eliminazione utilizzata per eliminare un canale.

Parameters

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.



Check-Channel

URI: https://www.botlibre.com/rest/api/check-channel
Operation: POST
Type: XML
API check-channel utilizzata per convalidare e restituire un canale.

Parameters

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.




Forum API URL Endpoint

Get-Forums

URI: https://www.botlibre.com/rest/api/get-forums
Operation: POST
Type: XML
API get-forums utilizzata per recuperare i forum disponibili.

Parameters

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.



Get-Forum-Posts

URI: https://www.botlibre.com/rest/api/get-forum-posts
Operation: POST
Type: XML
L'API get-forum-posts utilizzata per recuperare i post disponibili di ogni forum.

Parameters

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.



Get-Forum-Users

URI: https://www.botlibre.com/rest/api/get-forum-users
Operation: POST
Type: XML
API get-forum-users utilizzata per recuperare gli utenti di ogni forum.

Parameters

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.



Get-Forum-Admins

URI: https://www.botlibre.com/rest/api/get-forum-admins
Operation: POST
Type: XML
L'API get-forum-admins utilizzata per recuperare gli amministratori di ogni forum.

Parameters

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.



Save-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Get-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Create-Forum

URI: https://www.botlibre.com/rest/api/create-forum
Operation: POST
Type: XML
API create-forum per creare un nuovo forum.

Parameters

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.



Create-Forum-Attachment

URI: https://www.botlibre.com/rest/api/create-forum-attachment
Operation: POST
Type: XML
L'API create-forum-attachment per creare un forum che contiene un allegato.

Parameters

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.



Create-Forum-Post

URI: https://www.botlibre.com/rest/api/create-forum-post
Operation: POST
Type: XML
API create-forum-post per creare un nuovo post per un forum.

Parameters

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



Update-Forum

URI: https://www.botlibre.com/rest/api/update-forum
Operation: POST
Type: XML
L'API update-forum utilizzata per aggiornare i contenuti del forum.

Parameters

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.



Update-Forum-Post

URI: https://www.botlibre.com/rest/api/update-forum-post
Operation: POST
Type: XML
L'API update-forum-post aggiorna il contenuto di un post di un forum.

Parameters

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



Update-Forum-Icon

URI: https://www.botlibre.com/rest/api/update-forum-icon
Operation: POST
Type: XML
L'API update-forum-icon utilizzata per cambiare l'icona del fourm.

Parameters

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.



Check-Forum

URI: https://www.botlibre.com/rest/api/check-forum
Operation: POST
Type: XML
L'API del forum di controllo convalida e restituisce un forum.

Parameters

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.



Check-Forum-Post

URI: https://www.botlibre.com/rest/api/check-forum-post
Operation: POST
Type: XML
L'API check-forum-post controlla il post del forum per convalidare e restituisce un post di un forum.

Parameters

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.



Delete-Forum

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

Parameters

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.



Delete-Forum-Post

URI: https://www.botlibre.com/rest/api/delete-forum-post
Operation: POST
Type: XML
L'API delete-forum-post delete è un post di un forum.

Parameters

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.



Flag-Forum

URI: https://www.botlibre.com/rest/api/flag-forum
Operation: POST
Type: XML
API flag-forum utilizzata per contrassegnare un forum.

Parameters

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.



Flag-Forum-Post

URI: https://www.botlibre.com/rest/api/flag-forum-post
Operation: POST
Type: XML
Il flag-forum-post API flag è un post di un forum.

Parameters

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.



Thumbs-Up-Forum

URI: https://www.botlibre.com/rest/api/thumbs-up-forum
Operation: POST
Type: XML
L'API thumbs-up-forum utilizzata per posizionare un pollice in su in un forum.

Parameters

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.



Thumbs-Down-Forum

URI: https://www.botlibre.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
L'API thumbs-down-forum utilizzata per posizionare i pollici verso il basso in un forum.

Parameters

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.



Subscribe-Forum

URI: https://www.botlibre.com/rest/api/subscribe-forum
Operation: POST
Type: XML
L'API subscribe-forum consente a un utente di iscriversi a un forum.

Parameters

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.



Unsubscribe-Forum

URI: https://www.botlibre.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML
L'API unsubscribe-forum consente all'utente di annullare l'iscrizione a un forum.

Parameters

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.



Star-Forum

URI: https://www.botlibre.com/rest/api/star-forum
Operation: POST
Type: XML
L'API star-forum consente a un utente di inserire una stella in un forum.

Parameters

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.




Script API URL Endpoint

Get-Scripts

URI: https://www.botlibre.com/rest/api/get-scripts
Operation: POST
Type: XML
API get-scripts utilizzata per recuperare gli script disponibili.

Parameters

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.



Get-Script-Users

URI: https://www.botlibre.com/rest/api/get-script-users
Operation: POST
Type: XML
API get-script-users utilizzata per recuperare gli utenti di uno script.

Parameters

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.



Get-Script-Admins

URI: https://www.botlibre.com/rest/api/get-script-admins
Operation: POST
Type: XML
L'API get-script-admins consente di recuperare tutti gli amministratori di uno script.

Parameters

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.



Create-Script

URI: https://www.botlibre.com/rest/api/create-script
Operation: POST
Type: XML
L'API create-script viene utilizzata per creare un nuovo script.

Parameters

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).



Update-Script

URI: https://www.botlibre.com/rest/api/update-script
Operation: POST
Type: XML
API dello script di aggiornamento utilizzata per aggiornare il contenuto dello script.

Parameters

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.



Update-Script-Icon

URI: https://www.botlibre.com/rest/api/update-script-icon
Operation: POST
Type: XML
L'API update-script-icon utilizzata per modificare l'icona dello script.

Parameters

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.



Check-Script

URI: https://www.botlibre.com/rest/api/check-script
Operation: POST
Type: XML
L'API del forum di controllo convalida e restituisce uno script.

Parameters

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.



Delete-Script

URI: https://www.botlibre.com/rest/api/delete-script
Operation: POST
Type: XML
API delete-script per eliminare uno script.

Parameters

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.



Flag-Script

URI: https://www.botlibre.com/rest/api/flag-script
Operation: POST
Type: XML
API flag-script utilizzata per contrassegnare uno script.

Parameters

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.



Thumbs-Up-Script

URI: https://www.botlibre.com/rest/api/thumbs-up-script
Operation: POST
Type: XML
L'API del forum thumbs-up-utilizzato per posizionare un pollice in su a uno script.

Parameters

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.



Thumbs-Down-Script

URI: https://www.botlibre.com/rest/api/thumbs-down-script
Operation: POST
Type: XML
L'API del forum con il pollice in giù utilizzata per posizionare il pollice in giù a uno script.

Parameters

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.



Star-Script

URI: https://www.botlibre.com/rest/api/star-script
Operation: POST
Type: XML
L'API star-forum consente a un utente di inserire una stella in uno script.

Parameters

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.




Avatar API URL Endpoint

Get-Avatars

URI: https://www.botlibre.com/rest/api/get-avatars
Operation: POST
Type: XML
L'API get-avatars viene utilizzata per recuperare gli avatar disponibili.

Parameters

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.



Get-Avatar-Users

URI: https://www.botlibre.com/rest/api/get-avatar-users
Operation: POST
Type: XML
L'API get-avatars-users utilizzata per recuperare tutti gli utenti correlati a tale avatar.

Parameters

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.



Get-Avatar-Admins

URI: https://www.botlibre.com/rest/api/get-avatar-admins
Operation: POST
Type: XML
L'API get-avatar-admins utilizzata per recuperare tutti gli amministratori di un avatar selezionato.

Parameters

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.



Get-Avatar-Media

URI: https://www.botlibre.com/rest/api/get-avatar-media
Operation: POST
Type: XML
API get-avatar-media utilizzata per recuperare i file multimediali di un avatar.

Parameters

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.



Create-Avatar

URI: https://www.botlibre.com/rest/api/create-avatar
Operation: POST
Type: XML
API create-avatar utilizzata per creare un nuovo avatar.

Parameters

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).



Create-Avatar-Media

URI: https://www.botlibre.com/rest/api/create-avatar-media
Operation: POST
Type: XML
API create-avatar-media utilizzata per creare un file multimediale per un avatar.

Parameters

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.



Save-Avatar-Media

URI: https://www.botlibre.com/rest/api/save-avatar-media
Operation: POST
Type: XML
L'API save-avatar-media utilizzata per salvare le modifiche ai file multimediali correnti di un avatar.

Parameters

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.



Save-Avatar-Background

URI: https://www.botlibre.com/rest/api/save-avatar-background
Operation: POST
Type: XML
L'API save-avatar-background salva l'immagine di sfondo di un avatar.

Parameters

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.



Delete-Avatar

URI: https://www.botlibre.com/rest/api/delete-avatar
Operation: POST
Type: XML
API delete-avatar utilizzata per eliminare un avatar selezionato.

Parameters

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.



Delete-Avatar-Media

URI: https://www.botlibre.com/rest/api/delete-avatar-media
Operation: POST
Type: XML
L'API delete-avatar-media utilizzata per eliminare un file multimediale di un avatar.

Parameters

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.



Delete-Avatar-Background

URI: https://www.botlibre.com/rest/api/delete-avatar-background
Operation: POST
Type: XML
L'API delete-avatar-background utilizzata per eliminare un'immagine di sfondo di un avatar.

Parameters

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.



Check-Avatar

URI: https://www.botlibre.com/rest/api/check-avatar
Operation: POST
Type: XML
L'API check-avatar viene utilizzata per convalidare e restituire l'avatar.

Parameters

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.



Avatar-Message

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

Parameters

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.



Star-Avatar

URI: https://www.botlibre.com/rest/api/star-avatar
Operation: POST
Type: XML
L'API star-avatar utilizzata per l'utente per creare un avatar.

Parameters

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.



Flag-Avatar

URI: https://www.botlibre.com/rest/api/flag-avatar
Operation: POST
Type: XML
API flag-avatar utilizzata per contrassegnare un avatar.

Parameters

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.



Init-Avatar

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

Parameters

Parameter Required Type Description



Update-Avatar

URI: https://www.botlibre.com/rest/api/update-avatar
Operation: POST
Type: XML
L'API update-avatar utilizzata per aggiornare e modificare il contenuto di un avatar.

Parameters

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.



Update-Avatar-Icon

URI: https://www.botlibre.com/rest/api/update-avatar-icon
Operation: POST
Type: XML
L'API update-avatar-icon utilizzata per aggiornare l'icona dell'avatar

Parameters

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.



Thumbs-Up-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-up-avatar
Operation: POST
Type: XML
L'API thumbs-up-avatar utilizzata per posizionare un pollice in su su un avatar selezionato.

Parameters

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.



Thumbs-Down-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-down-avatar
Operation: POST
Type: XML
L'API thumbs-down-avatar utilizzata per posizionare un pollice verso il basso su un avatar selezionato.

Parameters

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.




Dominio URL Endpoint

Get-Domains

URI: https://www.botlibre.com/rest/api/get-domains
Operation: POST
Type: XML
API get-domains utilizzata per recuperare tutti i domini disponibili.

Parameters

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.



Get-Domain-Users

URI: https://www.botlibre.com/rest/api/get-domain-users
Operation: POST
Type: XML
API get-domain-users utilizzata per recuperare tutti gli utenti di un dominio.

Parameters

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.



Get-Domain-Admins

URI: https://www.botlibre.com/rest/api/get-domain-admins
Operation: POST
Type: XML
API get-domain-admins utilizzata per recuperare tutti gli amministratori di un dominio.

Parameters

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.



Get-Domain

URI: https://www.botlibre.com/rest/api/get-domain
Operation: POST
Type: XML
L'API get-domain recupera un dominio selezionato.

Parameters

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.



Get-Domain-Icon

URI: https://www.botlibre.com/rest/api/get-domain-icon
Operation: POST
Type: XML
API get-domain-icon utilizzata per restituire un'icona di un dominio.

Parameters

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.



Create-Domain

URI: https://www.botlibre.com/rest/api/create-domain
Operation: POST
Type: XML
L'API create-domain create è un nuovo dominio.

Parameters

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.



Check-Domain

URI: https://www.botlibre.com/rest/api/check-domain
Operation: POST
Type: XML
API del dominio di controllo utilizzata per convalidare e restituire un dominio.

Parameters

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.



Update-Domain

URI: https://www.botlibre.com/rest/api/update-domain
Operation: POST
Type: XML
L'API del dominio di aggiornamento aggiorna il contenuto del dominio.

Parameters

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.



Delete-Domain

URI: https://www.botlibre.com/rest/api/delete-domain
Operation: POST
Type: XML
L'API del dominio di eliminazione elimina un dominio selezionato.

Parameters

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.



Flag-Domain

URI: https://www.botlibre.com/rest/api/flag-domain
Operation: POST
Type: XML
API flag-domain utilizzata per contrassegnare un dominio.

Parameters

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.



Star-Domain

URI: https://www.botlibre.com/rest/api/star-domain
Operation: POST
Type: XML
L'API del dominio stellare utilizzata per posizionare una stella in un dominio.

Parameters

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.



Thumbs-Up-Domain

URI: https://www.botlibre.com/rest/api/thumbs-up-domain
Operation: POST
Type: XML
L'API del dominio thumbs-up utilizzata per eseguire il thumbs up di un dominio.

Parameters

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.



Thumbs-Down-Domain

URI: https://www.botlibre.com/rest/api/thumbs-down-domain
Operation: POST
Type: XML
L'API del dominio thumbs-down utilizzata per passare a un dominio selezionato.

Parameters

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.




Grafica URL Endpoint

Get-Graphics

URI: https://www.botlibre.com/rest/api/get-graphics
Operation: POST
Type: XML
L'API get-graphics recupera tutti gli elementi grafici disponibili.

Parameters

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.



Get-Graphic-Users

URI: https://www.botlibre.com/rest/api/get-graphic-users
Operation: POST
Type: XML
L'API get-graphic-users restituisce tutti gli utenti di un elemento grafico selezionato.

Parameters

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.



Get-Graphic-Admins

URI: https://www.botlibre.com/rest/api/get-graphic-admins
Operation: POST
Type: XML
L'API get-graphic-admins restituisce tutti gli amministratori di un elemento grafico selezionato.

Parameters

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.



Update-Graphic

URI: https://www.botlibre.com/rest/api/update-graphic
Operation: POST
Type: XML
API di aggiornamento grafico utilizzata per aggiornare il contenuto di un elemento grafico.

Parameters

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.



Update-Graphic-Icon

URI: https://www.botlibre.com/rest/api/update-graphic-icon
Operation: POST
Type: XML
API update-graphic-icon utilizzata per modificare e aggiornare l'icona grafica.

Parameters

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.



Update-Graphic-Media

URI: https://www.botlibre.com/rest/api/update-graphic-media
Operation: POST
Type: XML
API update-graphic-media utilizzata per aggiornare il contenuto multimediale dell'elemento grafico selezionato.

Parameters

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.



Create-Graphic

URI: https://www.botlibre.com/rest/api/create-graphic
Operation: POST
Type: XML
API create-graphic utilizzata per creare un nuovo elemento grafico.

Parameters

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).



Delete-Graphic

URI: https://www.botlibre.com/rest/api/delete-graphic
Operation: POST
Type: XML
API delete-graphic utilizzata per eliminare un elemento grafico selezionato.

Parameters

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.



Check-Graphic

URI: https://www.botlibre.com/rest/api/check-graphic
Operation: POST
Type: XML
API check-graphic utilizzata per convalidare un elemento grafico e restituirlo.

Parameters

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.



Flag-Graphic

URI: https://www.botlibre.com/rest/api/flag-graphic
Operation: POST
Type: XML
API flag-graphic utilizzata per contrassegnare un elemento grafico.

Parameters

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.



Star-Graphic

URI: https://www.botlibre.com/rest/api/star-graphic
Operation: POST
Type: XML
API grafica a stella utilizzata per posizionare una stella su un elemento grafico.

Parameters

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.



Thumbs-Up-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-up-graphic
Operation: POST
Type: XML
L'API thumbs-up-graphic utilizzata per posizionare un pollice in su su un elemento grafico selezionato.

Parameters

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.



Thumbs-Down-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-down-graphic
Operation: POST
Type: XML
L'API thumbs-down-graphic utilizzata per posizionare un pollice verso il basso su un elemento grafico selezionato.

Parameters

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.




Endpoint URL di analisi

Get-Analytics

URI: https://www.botlibre.com/rest/api/get-analytics
Operation: POST
Type: XML
L'API get-analytics utilizzata per recuperare tutte le analisi disponibili.

Parameters

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.



Get-Analytic-Users

URI: https://www.botlibre.com/rest/api/get-analytic-users
Operation: POST
Type: XML
API get-analytic-users utilizzata per recuperare tutti gli utenti di un'analisi.

Parameters

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.



Get-Analytic-Admins

URI: https://www.botlibre.com/rest/api/get-analytic-admins
Operation: POST
Type: XML
L'API get-analytic-admins utilizzata per recuperare tutti gli amministratori di un'analisi selezionata.

Parameters

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.



Test-Analytic

URI: https://www.botlibre.com/rest/api/test-analytic
Operation: POST
Type: XML
API di analisi di test utilizzata per testare un modello analitico addestrato con istruzioni specifiche.

Parameters

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.



Test-Audio-Analytic

URI: https://www.botlibre.com/rest/api/test-audio-analytic
Operation: POST
Type: XML
API test-audio-analytic utilizzata per testare un modello audio analitico.

Parameters

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.



Test-Object-Detection-Analytic

URI: https://www.botlibre.com/rest/api/test-object-detection-analytic
Operation: POST
Type: XML
L'API test-object-detection-analytic utilizzata per testare un modello analitico di rilevamento di oggetti con istruzioni specifiche.

Parameters

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.



Get-Test-Media-Result

URI: https://www.botlibre.com/rest/api/get-test-media-result
Operation: POST
Type: XML
L'API get-test-media-result recupera i risultati dei supporti di test.

Parameters

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.



Report-Media-Analytic

URI: https://www.botlibre.com/rest/api/report-media-analytic
Operation: POST
Type: XML
L'API report-media-analytic utilizzata per ottenere un reprot analitico.

Parameters

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.



Train-Analytic

URI: https://www.botlibre.com/rest/api/train-analytic
Operation: POST
Type: XML
API di analisi del treno utilizzata per eseguire il traino di un modello analitico.

Parameters

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.



Delete-Analytic-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-media
Operation: POST
Type: XML
API delete-analytic-media utilizzata per eliminare un supporto analitico selezionato.

Parameters

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.



Delete-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media
Operation: POST
Type: XML
API delete-analytic-test-media utilizzata per eliminare un supporto di test di un'analisi.

Parameters

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.



Get-Analytic-Media

URI: https://www.botlibre.com/rest/api/get-analytic-media
Operation: POST
Type: XML
API get-analytic-media utilizzata per recuperare tutti i supporti analitici.

Parameters

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.



Get-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/get-analytic-test-media
Operation: POST
Type: XML
L'API get-analytic-test-media recupera un supporto di test di un'analisi.

Parameters

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.



Create-Analytic-Label

URI: https://www.botlibre.com/rest/api/create-analytic-label
Operation: POST
Type: XML
Creare una o più etichette per un'analisi. Ogni etichetta è un classificatore. Ogni etichetta è come se un pacchetto contesse una serie di immagini. Questo è necessario prima di iniziare la fase di formazione per il riconoscimento delle immagini. Ogni analitico deve avere almeno due etichette.

Parameters

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.



Create-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/create-analytic-test-media-label
Operation: POST
Type: XML
Creare una o più etichette per un'analisi. Ogni etichetta è un classificatore. Ogni etichetta è come se un pacchetto contesse una serie di immagini. Questo è necessario prima di iniziare la fase di formazione per il riconoscimento delle immagini. Ogni analitico deve avere almeno due etichette.

Parameters

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.



Delete-Analytic-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-label
Operation: POST
Type: XML
API delete-analytic-label utilizzata per eliminare un'etichetta selezionata di un oggetto analitico.

Parameters

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.



Delete-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media-label
Operation: POST
Type: XML
API delete-analytic-test-media-label utilizzata per eliminare un'etichetta del supporto di test di un'analisi.

Parameters

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.



Check-Training

URI: https://www.botlibre.com/rest/api/check-training
Operation: POST
Type: XML
API di check-training utilizzata per recuperare alcune informazioni sul training corrente di un modello.

Parameters

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.



Create-Analytic

URI: https://www.botlibre.com/rest/api/create-analytic
Operation: POST
Type: XML
L'API create-analytic crea una nuova analisi.

Parameters

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).



Update-Analytic

URI: https://www.botlibre.com/rest/api/update-analytic
Operation: POST
Type: XML
L'API di analisi degli aggiornamenti aggiorna o modifica i dettagli di un'analisi selezionata.

Parameters

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.



Flag-Analytic

URI: https://www.botlibre.com/rest/api/flag-analytic
Operation: POST
Type: XML
API di analisi dei flag utilizzata per posizionare un flag in un oggetto analitico.

Parameters

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.



Thumbs-Up-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-up-analytic
Operation: POST
Type: XML
L'API di analisi thumbs-up utilizzata per eseguire il pollice in su di un'analisi.

Parameters

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.



Thumbs-Down-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
L'API di analisi thumbs-down utilizzata per passare a un'analisi analitica.

Parameters

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.



Star-Analytic

URI: https://www.botlibre.com/rest/api/star-analytic
Operation: POST
Type: XML
L'API di analisi delle stelle viene utilizzata per fissare un oggetto analitico.

Parameters

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.



Delete-Analytic

URI: https://www.botlibre.com/rest/api/delete-analytic
Operation: POST
Type: XML
API delete-analyic utilizzata per eliminare un'analisi selezionata.

Parameters

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.



Check-Analytic

URI: https://www.botlibre.com/rest/api/check-analytic
Operation: POST
Type: XML
API check-analytic utilizzata per convalidare un'istanza di un'analisi e restituirla.

Parameters

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.



Reset-Data-Analytic

URI: https://www.botlibre.com/rest/api/reset-data-analytic
Operation: POST
Type: XML
API rest-data-analytic utilizzata per riposare i dati di un'analisi selezionata.

Parameters

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.

Esempio

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



Test-Data-Analytic

URI: https://www.botlibre.com/rest/api/test-data-analytic
Operation: POST
Type: XML
Testare l'analisi dei dati con un set di input.

Parameters

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.

Esempio

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


Esempio Risultato

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


Train-Data-Analytic

URI: https://www.botlibre.com/rest/api/train-data-analytic
Operation: POST
Type: XML
Addestrare l'analisi dei dati con più set di input e output.

Parameters

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

Esempio

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





È possibile chiamare una qualsiasi delle API precedenti utilizzando JSON anziché XML utilizzando l'endpoint /rest/json Invece di /rest/api.



Vedi Anche