Web-API

Zusätzlich zu der Möglichkeit zum einbetten Ihres chat-bots auf Ihre eigene website, und Zugang Sie von jedem Android-oder iOS-Gerät, Sie können auch Zugriff auf Ihre chat-bots durch den Bot Libre web-API. Die web-API gibt Ihnen den Vorteil, dass die vollständige Kontrolle über Ihre bot-client-Schnittstelle.

Sie können die web-API Zugriff auf Ihre bot von Ihrer eigenen website durch JavaScript, PHP oder einer anderen Sprache. Sie können auch mit der web-API-erstellen Sie Ihre eigene mobile Anwendung für den Zugriff auf Ihr bot, wie ein Android-oder iOS-Anwendung.

Eine web-API ist ein Satz von HTTP-GET - /POST-URI ' s, die erlauben das senden und empfangen von message-Daten. Beim durchsuchen einer website, Ihr browser eine Reihe von HTTP-GET/POST-requests auf URIs, die Rückgabe von HTML-Inhalten. In einem web-service die URIs Rückkehr XML-oder JSON-Daten, anstelle von HTML-Inhalten.

Der Bot Libre web-API bietet drei REST-APIs in einem. Die erste ist eine Reihe von GET-HTTP-URIs, die FORM-Daten und XML-Daten zurückgeben. Der zweite Satz von API ' s nehmen HTTP-POST XML-Daten und XML-Daten zurückgeben. Der Dritte Satz von API ' s nehmen Sie eine HTTP-POST-JSON-Daten und die Rückgabe von JSON-Daten.

Die meisten Anwendungen verwenden XML-POST API, aber einige Anwendung kann wählen, um die FORM zu BEKOMMEN-API wegen seiner Einfachheit. Die APIs sind identisch zu anderen als Ihren Mechanismus.

Chat-API-URL-Endpunkte

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.

Benutzer-API-URL-Endpunkte

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

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

Forum-API-URL-Endpunkte

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

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

Avatar-API-URL-Endpunkte

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

Domain URL-Endpunkte

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.

Grafik-URL-Endpunkte

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

Analytics-URL-Endpunkte

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

Form Chat

URI: https://www.botlibre.com/rest/api/form-chat
Operation: GET
Type: Form
Die form-chat-API erhält eine chat-Nachricht und gibt den chat-bot-Antwort als XML-Dokument.

Parameters

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

Beispiel

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

Beispiel Ergebnis

<?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
Die chat-API erhält eine chat-Nachricht und gibt den chat-bot-Antwort als XML-Dokument.

Parameters

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

Beispiel

Beispiel Ergebnis

JSON Chat

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

Parameters

Parameter	Required	Type	Description

Benutzer-API-URL-Endpunkte

Form-Check-User

URI: https://www.botlibre.com/rest/api/form-check-user
Operation: GET
Type: Form
Die Formular-Check-User-API überprüft den Benutzer und gibt die Benutzerdetails zurück.

Parameters

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

Beispiel

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

Beispiel Ergebnis

<?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
Die Check-User-API überprüft den Benutzer und gibt die Benutzerdetails zurück.

Parameters

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

Beispiel

Beispiel Ergebnis

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

Bot-API-URL-Endpunkte

Get-Bots

URI: https://www.botlibre.com/rest/api/get-bots
Operation: POST
Type: XML
Die get-bots-API, die zum Abrufen aller verfügbaren Bots verwendet wird.

Parameters

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

Get-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/get-bot-script-source
Operation: POST
Type: XML
Die get-bot-script-source-API, die zum Abrufen der Quelle des Skripts verwendet wird.

Parameters

Parameter	Required	Type	Description

Delete-Bot

URI: https://www.botlibre.com/rest/api/delete-bot
Operation: POST
Type: XML
Die delete-bot API löscht den ausgewählten Bot.

Parameters

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

Delete-Bot-Script

URI: https://www.botlibre.com/rest/api/delete-bot-script
Operation: POST
Type: XML
Die delete-bot-script-API, die zum Löschen eines Skripts aus einem Bot verwendet wird.

Parameters

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

Import-Bot-Script

URI: https://www.botlibre.com/rest/api/import-bot-script
Operation: POST
Type: XML
Die Import-Bot-Skript-API, die zum Importieren eines Skripts in einen Bot verwendet wird.

Parameters

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

Import-Bot-Log

URI: https://www.botlibre.com/rest/api/import-bot-log
Operation: POST
Type: XML
Die Import-Bot-Log-API, die zum Importieren von Protokollen eines Bots verwendet wird.

Parameters

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

Save-Bot-Avatar

URI: https://www.botlibre.com/rest/api/save-bot-avatar
Operation: POST
Type: XML
Die Save-Bot-Avatar-API, mit der ein Avatar ausgewählt und für einen Bot gespeichert wird.

Parameters

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

Save-Bot-Script-Source

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

Parameters

Parameter	Required	Type	Description

Create-Bot-Attachment

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

Parameters

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

Up-Bot-Script

URI: https://www.botlibre.com/rest/api/up-bot-script
Operation: POST
Type: XML
Die Up-Bot-Script-API, die zum Verschieben des Bot-Skripts nach oben verwendet wird.

Parameters

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

Down-Bot-Script

URI: https://www.botlibre.com/rest/api/down-bot-script
Operation: POST
Type: XML
Die Down-Bot-Script-API, die zum Verschieben des Bot-Skripts verwendet wird.

Parameters

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

Get-Instances

URI: https://www.botlibre.com/rest/api/get-instances
Operation: POST
Type: XML
Die get-instances-API ruft alle verfügbaren Instances ab.

Parameters

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

Get-Instance-Users

URI: https://www.botlibre.com/rest/api/get-instance-users
Operation: POST
Type: XML
Die get-instance-users-API ruft alle Benutzer dieser Instanz ab.

Parameters

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

Get-Instance-Admins

URI: https://www.botlibre.com/rest/api/get-instance-admins
Operation: POST
Type: XML
Die get-instance-admins-API ruft alle Administratoren dieser Instanz ab.

Parameters

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

Get-All-Instances

URI: https://www.botlibre.com/rest/api/get-all-instances
Operation: POST
Type: XML
Die api \"form-get-all-instances\" fragt die Details für alle Bot-Instanzen ab.

Parameters

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

Beispiel

Beispiel Ergebnis

<?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
Die Check-Instance-API überprüft, ob eine Bot-ID oder ein Name vorhanden ist, und gibt die Daten des Bots zurück.

Parameters

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

Beispiel

Beispiel Ergebnis

<?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
Die Formular-Check-Instanz-API überprüft, ob eine Bot-ID oder ein Name vorhanden ist, und gibt die Details des Bots zurück.

Parameters

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

Beispiel

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

Beispiel Ergebnis

Form-Get-All-Instances

URI: https://www.botlibre.com/rest/api/form-get-all-instances
Operation: GET
Type: Form
Die api \"form-get-all-instances\" fragt die Details für alle Bot-Instanzen ab.

Parameters

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

Beispiel

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

Beispiel Ergebnis

<?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
Mit der Update-Instance-API kann der Benutzer alle Inhalte der ausgewählten Bot-Instanz aktualisieren

Parameters

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

Update-Instance-Icon

URI: https://www.botlibre.com/rest/api/update-instance-icon
Operation: POST
Type: XML
Die update-instance-icon API lässt den Benutzer das Symbol der Bot-Instanz ändern.

Parameters

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

Create-Instance

URI: https://www.botlibre.com/rest/api/create-instance
Operation: POST
Type: XML
Die Create-Instance-API zum Erstellen einer neuen Bot-Instance.

Parameters

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

Edit-Instance

URI: https://www.botlibre.com/rest/api/edit-instance
Operation: POST
Type: XML
Die Edit-Instance-API zum Bearbeiten und Aktualisieren der Bot-Instanz.

Parameters

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

Delete-Instance

URI: https://www.botlibre.com/rest/api/delete-instance
Operation: POST
Type: XML
Die Delete-Instance-API zum Löschen einer Bot-Instance.

Parameters

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

Flag-Instance

URI: https://www.botlibre.com/rest/api/flag-instance
Operation: POST
Type: XML
Die Flag-Instance-API Flag einer Bot-Instance.

Parameters

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

Star-Instance

URI: https://www.botlibre.com/rest/api/star-instance
Operation: POST
Type: XML
Die Stern-Instance-API ist eine Bot-Instance.

Parameters

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

Train-Instance

URI: https://www.botlibre.com/rest/api/train-instance
Operation: POST
Type: XML
Die Train-Instance-API trainiert eine Chat-Bot-Instanz.

Parameters

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

Thumbs-Up-Instance

URI: https://www.botlibre.com/rest/api/thumbs-up-instance
Operation: POST
Type: XML
Die Thumbs-up-Instance-API, die ein Benutzer auf eine Chat-Bot-Instanz legen kann, kann einen Daumen hoch setzen.

Parameters

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

Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-instance
Operation: POST
Type: XML
Die Thumbs-Down-Instanz, die ein Benutzer auf eine Chatbot-Instanz legen kann

Parameters

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

Forum-API-URL-Endpunkte

Get-Forums

URI: https://www.botlibre.com/rest/api/get-forums
Operation: POST
Type: XML
Die get-forums-API, die zum Abrufen verfügbarer Foren verwendet wird.

Parameters

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

Get-Forum-Posts

URI: https://www.botlibre.com/rest/api/get-forum-posts
Operation: POST
Type: XML
Die get-forum-posts API, die verwendet wird, um verfügbare Beiträge jedes Forums abzurufen.

Parameters

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

Get-Forum-Users

URI: https://www.botlibre.com/rest/api/get-forum-users
Operation: POST
Type: XML
Die get-forum-users-API, die zum Abrufen von Benutzern jedes Forums verwendet wird.

Parameters

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

Get-Forum-Admins

URI: https://www.botlibre.com/rest/api/get-forum-admins
Operation: POST
Type: XML
Die get-forum-admins-API, die zum Abrufen von Administratoren jedes Forums verwendet wird.

Parameters

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

Save-Forum-Bot-Mode

URI: https://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
Die create-forum API, um ein neues Forum zu erstellen.

Parameters

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

Create-Forum-Attachment

URI: https://www.botlibre.com/rest/api/create-forum-attachment
Operation: POST
Type: XML
Die create-forum-attachment API zum Erstellen eines Forums, das einen Anhang enthält.

Parameters

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

Create-Forum-Post

URI: https://www.botlibre.com/rest/api/create-forum-post
Operation: POST
Type: XML
Die create-forum-post API, um einen neuen Beitrag für ein Forum zu erstellen.

Parameters

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

Update-Forum

URI: https://www.botlibre.com/rest/api/update-forum
Operation: POST
Type: XML
Die update-forum API, die verwendet wird, um die Inhalte des Forums zu aktualisieren.

Parameters

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

Update-Forum-Post

URI: https://www.botlibre.com/rest/api/update-forum-post
Operation: POST
Type: XML
Die update-forum-post API aktualisiert den Inhalt eines Beitrags eines Forums.

Parameters

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

Update-Forum-Icon

URI: https://www.botlibre.com/rest/api/update-forum-icon
Operation: POST
Type: XML
Die update-forum-icon API wurde verwendet, um das Symbol des Fourm zu ändern.

Parameters

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

Check-Forum

URI: https://www.botlibre.com/rest/api/check-forum
Operation: POST
Type: XML
Die Check-Forum-API validiert und gibt ein Forum zurück.

Parameters

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

Check-Forum-Post

URI: https://www.botlibre.com/rest/api/check-forum-post
Operation: POST
Type: XML
Die check-forum-post API überprüft den Beitrag des Forums auf Validierung und gibt einen Beitrag eines Forums zurück.

Parameters

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

Delete-Forum

URI: https://www.botlibre.com/rest/api/delete-forum
Operation: POST
Type: XML
Die delete-forum API zum Löschen eines Forums.

Parameters

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

Delete-Forum-Post

URI: https://www.botlibre.com/rest/api/delete-forum-post
Operation: POST
Type: XML
Die delete-forum-post API delete ist ein Beitrag eines Forums.

Parameters

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

Flag-Forum

URI: https://www.botlibre.com/rest/api/flag-forum
Operation: POST
Type: XML
Die Flag-Forum-API, die zum Kennzeichnen eines Forums verwendet wird.

Parameters

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

Flag-Forum-Post

URI: https://www.botlibre.com/rest/api/flag-forum-post
Operation: POST
Type: XML
Das Flag-Forum-Post-API-Flag ist ein Beitrag eines Forums.

Parameters

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

Thumbs-Up-Forum

URI: https://www.botlibre.com/rest/api/thumbs-up-forum
Operation: POST
Type: XML
Die Thumbs-up-Forum-API wird verwendet, um einen Daumen hoch in ein Forum zu platzieren.

Parameters

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

Thumbs-Down-Forum

URI: https://www.botlibre.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
Die Thumbs-down-Forum-API wird verwendet, um Daumen nach unten in ein Forum zu platzieren.

Parameters

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

URI: https://www.botlibre.com/rest/api/subscribe-forum
Operation: POST
Type: XML
Die Subscribe-Forum-API soll es einem Benutzer ermöglichen, ein Forum zu abonnieren.

Parameters

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

Unsubscribe-Forum

URI: https://www.botlibre.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML
Die Abmeldeforum-API soll es dem Benutzer ermöglichen, sich von einem Forum abzumelden.

Parameters

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

Star-Forum

URI: https://www.botlibre.com/rest/api/star-forum
Operation: POST
Type: XML
Die Star-Forum-API soll es einem Benutzer ermöglichen, einen Stern in einem Forum zu platzieren.

Parameters

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

Script-API-URL-Endpunkte

Get-Forums

URI: https://www.botlibre.com/rest/api/get-forums
Operation: POST
Type: XML
Die get-forums-API, die zum Abrufen verfügbarer Foren verwendet wird.

Parameters

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

Get-Forum-Posts

URI: https://www.botlibre.com/rest/api/get-forum-posts
Operation: POST
Type: XML
Die get-forum-posts API, die verwendet wird, um verfügbare Beiträge jedes Forums abzurufen.

Parameters

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

Get-Forum-Users

URI: https://www.botlibre.com/rest/api/get-forum-users
Operation: POST
Type: XML
Die get-forum-users-API, die zum Abrufen von Benutzern jedes Forums verwendet wird.

Parameters

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

Get-Forum-Admins

URI: https://www.botlibre.com/rest/api/get-forum-admins
Operation: POST
Type: XML
Die get-forum-admins API dient dazu, alle Administratoren eines Forums abzurufen.

Parameters

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

Save-Forum-Bot-Mode

URI: https://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
Die create-forum API wird verwendet, um ein neues Forum zu erstellen.

Parameters

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

Create-Forum-Attachment

URI: https://www.botlibre.com/rest/api/create-forum-attachment
Operation: POST
Type: XML
Die create-forum-attachment API zum Erstellen eines Forums, das einen Anhang enthält.

Parameters

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

Create-Forum-Post

URI: https://www.botlibre.com/rest/api/create-forum-post
Operation: POST
Type: XML
Die create-forum-post API, um einen neuen Beitrag für ein Forum zu erstellen.

Parameters

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

Update-Forum

URI: https://www.botlibre.com/rest/api/update-forum
Operation: POST
Type: XML
Die update-forum API, die verwendet wird, um die Inhalte des Forums zu aktualisieren.

Parameters

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

Update-Forum-Post

URI: https://www.botlibre.com/rest/api/update-forum-post
Operation: POST
Type: XML
Die update-forum-post API aktualisiert den Inhalt eines Beitrags eines Forums.

Parameters

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

Update-Forum-Icon

URI: https://www.botlibre.com/rest/api/update-forum-icon
Operation: POST
Type: XML
Die update-forum-icon API wurde verwendet, um das Symbol des Fourm zu ändern.

Parameters

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

Check-Forum

URI: https://www.botlibre.com/rest/api/check-forum
Operation: POST
Type: XML
Die Check-Forum-API validiert und gibt ein Forum zurück.

Parameters

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

Check-Forum-Post

Parameters

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

Delete-Forum

URI: https://www.botlibre.com/rest/api/delete-forum
Operation: POST
Type: XML
Die delete-forum API zum Löschen eines Forums.

Parameters

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

Delete-Forum-Post

URI: https://www.botlibre.com/rest/api/delete-forum-post
Operation: POST
Type: XML
Die delete-forum-post API delete ist ein Beitrag eines Forums.

Parameters

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

Flag-Forum

URI: https://www.botlibre.com/rest/api/flag-forum
Operation: POST
Type: XML
Die Flag-Forum-API, die zum Kennzeichnen eines Forums verwendet wird.

Parameters

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

Flag-Forum-Post

URI: https://www.botlibre.com/rest/api/flag-forum-post
Operation: POST
Type: XML
Das Flag-Forum-Post-API-Flag ist ein Beitrag eines Forums.

Parameters

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

Thumbs-Up-Forum

URI: https://www.botlibre.com/rest/api/thumbs-up-forum
Operation: POST
Type: XML
Die Thumbs-up-Forum-API wird verwendet, um einen Daumen hoch in ein Forum zu platzieren.

Parameters

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

Thumbs-Down-Forum

URI: https://www.botlibre.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
Die Thumbs-down-Forum-API wird verwendet, um Daumen nach unten in ein Forum zu platzieren.

Parameters

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

URI: https://www.botlibre.com/rest/api/subscribe-forum
Operation: POST
Type: XML
Die Subscribe-Forum-API soll es einem Benutzer ermöglichen, ein Forum zu abonnieren.

Parameters

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

Unsubscribe-Forum

URI: https://www.botlibre.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML
Die Abmeldeforum-API soll es dem Benutzer ermöglichen, sich von einem Forum abzumelden.

Parameters

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

Star-Forum

URI: https://www.botlibre.com/rest/api/star-forum
Operation: POST
Type: XML
Die Star-Forum-API soll es einem Benutzer ermöglichen, einen Stern in einem Forum zu platzieren.

Parameters

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

Avatar-API-URL-Endpunkte

Get-Avatars

URI: https://www.botlibre.com/rest/api/get-avatars
Operation: POST
Type: XML
Die get-avatars API wird verwendet, um verfügbare Avatare abzurufen.

Parameters

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

Get-Avatar-Users

URI: https://www.botlibre.com/rest/api/get-avatar-users
Operation: POST
Type: XML
Die get-avatars-users-API, die zum Abrufen aller Benutzer verwendet wird, die mit diesem Avatar in Verbindung stehen.

Parameters

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

Get-Avatar-Admins

URI: https://www.botlibre.com/rest/api/get-avatar-admins
Operation: POST
Type: XML
Die get-avatar-admins-API, mit der alle Administratoren eines ausgewählten Avatars abgerufen werden.

Parameters

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

Get-Avatar-Media

URI: https://www.botlibre.com/rest/api/get-avatar-media
Operation: POST
Type: XML
Die get-avatar-media-API, die zum Abrufen der Medien eines Avatars verwendet wird.

Parameters

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

Create-Avatar

URI: https://www.botlibre.com/rest/api/create-avatar
Operation: POST
Type: XML
Die Create-Avatar-API, die zum Erstellen eines neuen Avatars verwendet wird.

Parameters

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

Create-Avatar-Media

URI: https://www.botlibre.com/rest/api/create-avatar-media
Operation: POST
Type: XML
Die create-avatar-media API, die zum Erstellen eines Mediums für einen Avatar verwendet wird.

Parameters

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

Save-Avatar-Media

URI: https://www.botlibre.com/rest/api/save-avatar-media
Operation: POST
Type: XML
Die Save-Avatar-Media-API, die zum Speichern der aktuellen Medien eines Avatars verwendet wird.

Parameters

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

Save-Avatar-Background

URI: https://www.botlibre.com/rest/api/save-avatar-background
Operation: POST
Type: XML
Die Save-Avatar-Background-API speichert das Hintergrundbild eines Avatars.

Parameters

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

Save-Bot-Avatar

URI: https://www.botlibre.com/rest/api/save-bot-avatar
Operation: POST
Type: XML
Die Save-Bot-Avatar-API, mit der ein Avatar ausgewählt und für einen Bot gespeichert wird.

Parameters

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

Delete-Avatar

URI: https://www.botlibre.com/rest/api/delete-avatar
Operation: POST
Type: XML
Die delete-avatar API, die zum Löschen eines ausgewählten Avatars verwendet wird.

Parameters

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

Delete-Avatar-Media

URI: https://www.botlibre.com/rest/api/delete-avatar-media
Operation: POST
Type: XML
Die delete-avatar-media-API, die zum Löschen eines Mediums eines Avatars verwendet wird.

Parameters

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

Delete-Avatar-Background

URI: https://www.botlibre.com/rest/api/delete-avatar-background
Operation: POST
Type: XML
Die Delete-Avatar-Background-API, die zum Löschen eines Hintergrundbilds eines Avatars verwendet wird.

Parameters

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

Check-Avatar

URI: https://www.botlibre.com/rest/api/check-avatar
Operation: POST
Type: XML
Die check-avatar API wird verwendet, um den Avatar zu validieren und zurückzugeben.

Parameters

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

Avatar-Message

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

Parameters

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

Star-Avatar

URI: https://www.botlibre.com/rest/api/star-avatar
Operation: POST
Type: XML
Die Stern-Avatar-API, die für den Benutzer verwendet wird, um einen Avatar zu sternn.

Parameters

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

Flag-Avatar

URI: https://www.botlibre.com/rest/api/flag-avatar
Operation: POST
Type: XML
Die Flag-Avatar-API, die zum Kennzeichnen eines Avatars verwendet wird.

Parameters

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

Init-Avatar

URI: https://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
Die Update-Avatar-API, die zum Aktualisieren und Ändern des Inhalts eines Avatars verwendet wird.

Parameters

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

Update-Avatar-Icon

URI: https://www.botlibre.com/rest/api/update-avatar-icon
Operation: POST
Type: XML
Die update-avatar-icon-API, die zum Aktualisieren des Avatarsymbols verwendet wird

Parameters

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

Thumbs-Up-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-up-avatar
Operation: POST
Type: XML
Die Thumbs-up-Avatar-API, die verwendet wird, um einen Daumen nach oben auf einen ausgewählten Avatar zu setzen.

Parameters

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

Thumbs-Down-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-down-avatar
Operation: POST
Type: XML
Die Thumbs-down-Avatar-API, mit der ein Daumen nach unten zu einem ausgewählten Avatar enern.

Parameters

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

Domain URL-Endpunkte

Get-Domains

URI: https://www.botlibre.com/rest/api/get-domains
Operation: POST
Type: XML
Die get-domains-API, die zum Abrufen aller verfügbaren Domänen verwendet wird.

Parameters

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

Get-Domain-Users

URI: https://www.botlibre.com/rest/api/get-domain-users
Operation: POST
Type: XML
Die get-domain-users-API, die zum Abrufen aller Benutzer einer Domäne verwendet wird.

Parameters

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

Get-Domain-Admins

URI: https://www.botlibre.com/rest/api/get-domain-admins
Operation: POST
Type: XML
Die get-domain-admins-API, die zum Abrufen aller Administratoren einer Domäne verwendet wird.

Parameters

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

Get-Domain

URI: https://www.botlibre.com/rest/api/get-domain
Operation: POST
Type: XML
Die get-domain-API ruft eine ausgewählte Domäne ab.

Parameters

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

Get-Domain-Icon

URI: https://www.botlibre.com/rest/api/get-domain-icon
Operation: POST
Type: XML
Die get-domain-icon-API, die zum Zurückgeben eines Symbols einer Domäne verwendet wird.

Parameters

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

Create-Domain

URI: https://www.botlibre.com/rest/api/create-domain
Operation: POST
Type: XML
Die Create-Domain-API erstellt eine neue Domäne.

Parameters

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

Check-Domain

URI: https://www.botlibre.com/rest/api/check-domain
Operation: POST
Type: XML
Die Check-Domain-API, die zum Überprüfen und Zurückgeben einer Domäne verwendet wird.

Parameters

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

Update-Domain

URI: https://www.botlibre.com/rest/api/update-domain
Operation: POST
Type: XML
Die update-domain-API aktualisiert den Inhalt der Domäne.

Parameters

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

Delete-Domain

URI: https://www.botlibre.com/rest/api/delete-domain
Operation: POST
Type: XML
Die Delete-Domain-API löscht eine ausgewählte Domäne.

Parameters

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

Flag-Domain

URI: https://www.botlibre.com/rest/api/flag-domain
Operation: POST
Type: XML
Die falg-domain-API, die zum Kennzeichnen einer Domäne verwendet wird.

Parameters

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

Star-Domain

URI: https://www.botlibre.com/rest/api/star-domain
Operation: POST
Type: XML
Die Star-Domain-API, die verwendet wird, um einen Stern in einer Domain zu platzieren.

Parameters

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

Thumbs-Up-Domain

URI: https://www.botlibre.com/rest/api/thumbs-up-domain
Operation: POST
Type: XML
Die Thumbs-up-Domain-API, die zum Aufstellen einer Domäne verwendet wird.

Parameters

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

Thumbs-Down-Domain

URI: https://www.botlibre.com/rest/api/thumbs-down-domain
Operation: POST
Type: XML
Die Thumbs-down-Domain-API, die zum Thumbs-Down zu einer ausgewählten Domäne verwendet wird.

Parameters

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

Grafik-URL-Endpunkte

Get-Graphics

URI: https://www.botlibre.com/rest/api/get-graphics
Operation: POST
Type: XML
Die get-graphics-API ruft alle verfügbaren Grafiken ab.

Parameters

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

Get-Graphic-Users

URI: https://www.botlibre.com/rest/api/get-graphic-users
Operation: POST
Type: XML
Die get-graphic-users-API gibt alle Benutzer einer ausgewählten Grafik zurück.

Parameters

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

Get-Graphic-Admins

URI: https://www.botlibre.com/rest/api/get-graphic-admins
Operation: POST
Type: XML
Die get-graphic-admins-API gibt alle Administratoren einer ausgewählten Grafik zurück.

Parameters

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

Update-Graphic

URI: https://www.botlibre.com/rest/api/update-graphic
Operation: POST
Type: XML
Die Update-Grafik-API, die zum Aktualisieren des Inhalts einer Grafik verwendet wird.

Parameters

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

Update-Graphic-Icon

URI: https://www.botlibre.com/rest/api/update-graphic-icon
Operation: POST
Type: XML
Die Update-Grafiksymbol-API, die zum Ändern und Aktualisieren des Grafiksymbols verwendet wird.

Parameters

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

Update-Graphic-Media

URI: https://www.botlibre.com/rest/api/update-graphic-media
Operation: POST
Type: XML
Die Update-Grafik-Medien-API, die zum Aktualisieren des Medieninhalts der ausgewählten Grafik verwendet wird.

Parameters

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

Create-Graphic

URI: https://www.botlibre.com/rest/api/create-graphic
Operation: POST
Type: XML
Die Create-Graphic-API, die zum Erstellen einer neuen Grafik verwendet wird.

Parameters

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

Delete-Graphic

URI: https://www.botlibre.com/rest/api/delete-graphic
Operation: POST
Type: XML
Die Löschgrafik-API, die zum Löschen einer ausgewählten Grafik verwendet wird.

Parameters

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

Check-Graphic

URI: https://www.botlibre.com/rest/api/check-graphic
Operation: POST
Type: XML
Die Check-Graphic-API, die verwendet wird, um eine Grafik zu validieren und zurückzugeben.

Parameters

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

Flag-Graphic

URI: https://www.botlibre.com/rest/api/flag-graphic
Operation: POST
Type: XML
Die Flag-Grafik-API, die zum Kennzeichnen einer Grafik verwendet wird.

Parameters

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

Star-Graphic

URI: https://www.botlibre.com/rest/api/star-graphic
Operation: POST
Type: XML
Die Sterngrafik-API, die verwendet wird, um einen Stern in einer Grafik zu platzieren.

Parameters

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

Thumbs-Up-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-up-graphic
Operation: POST
Type: XML
Die Thumbs-up-Grafik-API, die verwendet wird, um einen Daumen nach oben auf einer ausgewählten Grafik zu platzieren.

Parameters

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

Thumbs-Down-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-down-graphic
Operation: POST
Type: XML
Die Thumbs-down-Grafik-API, die verwendet wird, um einen Daumen nach unten zu einer ausgewählten Grafik zu platzieren.

Parameters

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

Analytics-URL-Endpunkte

Get-Analytics

URI: https://www.botlibre.com/rest/api/get-analytics
Operation: POST
Type: XML
Die get-analytics-API, die zum Abrufen aller verfügbaren Analysen verwendet wird.

Parameters

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

Get-Analytic-Users

URI: https://www.botlibre.com/rest/api/get-analytic-users
Operation: POST
Type: XML
Die get-analytic-users-API, die zum Abrufen aller Benutzer einer Analyse verwendet wird.

Parameters

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

Get-Analytic-Admins

URI: https://www.botlibre.com/rest/api/get-analytic-admins
Operation: POST
Type: XML
Die get-analytic-admins-API, die zum Abrufen aller Administratoren einer ausgewählten Analyse verwendet wird.

Parameters

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

Test-Analytic

URI: https://www.botlibre.com/rest/api/test-analytic
Operation: POST
Type: XML
Die testanalytische API, die zum Testen eines trainierten Analysemodells mit spezifischen Anweisungen verwendet wird.

Parameters

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

Test-Audio-Analytic

URI: https://www.botlibre.com/rest/api/test-audio-analytic
Operation: POST
Type: XML
Die Test-Audio-Analyse-API, die zum Testen einer Audiomodellanalyse verwendet wird.

Parameters

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

Test-Object-Detection-Analytic

URI: https://www.botlibre.com/rest/api/test-object-detection-analytic
Operation: POST
Type: XML
Die Testobjekterkennungs-Analyse-API, die zum Testen eines Analysemodells für die Objekterkennung mit spezifischen Anweisungen verwendet wird.

Parameters

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

Get-Test-Media-Result

URI: https://www.botlibre.com/rest/api/get-test-media-result
Operation: POST
Type: XML
Die get-test-media-result-API ruft Testergebnisse ab.

Parameters

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

Report-Media-Analytic

URI: https://www.botlibre.com/rest/api/report-media-analytic
Operation: POST
Type: XML
Die Report-Media-Analyse-API, die verwendet wird, um eine analytische Wiederholung zu erhalten.

Parameters

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

Train-Analytic

URI: https://www.botlibre.com/rest/api/train-analytic
Operation: POST
Type: XML
Die Train-Analytic-API, die zum Trainieren eines Analysemodells verwendet wird.

Parameters

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

Delete-Analytic-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-media
Operation: POST
Type: XML
Die delete-analytic-media-API, die zum Löschen eines ausgewählten Analysemediums verwendet wird.

Parameters

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

Delete-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media
Operation: POST
Type: XML
Die delete-analytic-test-media-API, die zum Löschen eines Testmediums einer Analyse verwendet wird.

Parameters

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

Get-Analytic-Media

URI: https://www.botlibre.com/rest/api/get-analytic-media
Operation: POST
Type: XML
Die get-analytic-media-API, die zum Abrufen aller Analysemedien verwendet wird.

Parameters

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

Get-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/get-analytic-test-media
Operation: POST
Type: XML
Die get-analytic-test-media-API ruft ein Testmedium einer Analyse ab.

Parameters

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

Create-Analytic-Label

URI: https://www.botlibre.com/rest/api/create-analytic-label
Operation: POST
Type: XML
Erstellen Sie eine oder andere Bezeichnungen für eine Analyse. Jedes Label ist ein Klassifikator. Jedes Etikett ist wie ein Paket, das eine Reihe von Bildern enthält. Dies ist vor Beginn der Trainingsphase zur Bilderkennung erforderlich. Jeder Analytic muss mindestens zwei Labels haben.

Parameters

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

Create-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/create-analytic-test-media-label
Operation: POST
Type: XML
Erstellen Sie eine oder andere Bezeichnungen für eine Analyse. Jedes Label ist ein Klassifikator. Jedes Etikett ist wie ein Paket, das eine Reihe von Bildern enthält. Dies ist vor Beginn der Trainingsphase zur Bilderkennung erforderlich. Jeder Analytic muss mindestens zwei Labels haben.

Parameters

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

Delete-Analytic-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-label
Operation: POST
Type: XML
Die delete-analytic-label-API, die zum Löschen einer ausgewählten Bezeichnung eines Analyseobjekts verwendet wird.

Parameters

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

Delete-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media-label
Operation: POST
Type: XML
Die delete-analytic-test-media-label-API, die zum Löschen einer Testmedienbezeichnung einer Analyse verwendet wird.

Parameters

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

Check-Training

URI: https://www.botlibre.com/rest/api/check-training
Operation: POST
Type: XML
Die Check-Training-API, die verwendet wird, um einige Informationen des aktuellen Trainings eines Modells abzurufen.

Parameters

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

Create-Analytic

URI: https://www.botlibre.com/rest/api/create-analytic
Operation: POST
Type: XML
Die create-analytic API erstellt ein neues Analytic.

Parameters

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

Update-Analytic

URI: https://www.botlibre.com/rest/api/update-analytic
Operation: POST
Type: XML
Die updateanalytische API aktualisiert oder ändert die Details einer ausgewählten Analyse.

Parameters

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

Flag-Analytic

URI: https://www.botlibre.com/rest/api/flag-analytic
Operation: POST
Type: XML
Die Flag-Analyse-API, die zum Platzieren eines Flags für ein Analytic verwendet wird.

Parameters

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

Thumbs-Up-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-up-analytic
Operation: POST
Type: XML
Die Thumbs-up-Analyse-API, die zum Aufstellen eines Analytic verwendet wird.

Parameters

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

Thumbs-Down-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
Die Thumbs-down-Analyse-API, die verwendet wird, um zu einem Analytic zu daumenab.

Parameters

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

Star-Analytic

URI: https://www.botlibre.com/rest/api/star-analytic
Operation: POST
Type: XML
Die sternanalytische API wird verwendet, um ein analytisches Objekt zu sternn.

Parameters

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

Delete-Analytic

URI: https://www.botlibre.com/rest/api/delete-analytic
Operation: POST
Type: XML
Die delete-analyic API, die zum Löschen einer ausgewählten Analyse verwendet wird.

Parameters

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

Check-Analytic

URI: https://www.botlibre.com/rest/api/check-analytic
Operation: POST
Type: XML
Die Check-Analytic-API, die verwendet wird, um eine Instanz einer Analyse zu validieren und zurückzugeben.

Parameters

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

Reset-Data-Analytic

URI: https://www.botlibre.com/rest/api/reset-data-analytic
Operation: POST
Type: XML
Die API für die Restdatenanalyse, die zum Aufspeichern der Daten einer ausgewählten Analyse verwendet wird.

Parameters

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

Beispiel

Test-Data-Analytic

URI: https://www.botlibre.com/rest/api/test-data-analytic
Operation: POST
Type: XML
Testen Sie die Datenanalyse mit einem Satz von Eingaben.

Parameters

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

Beispiel

Beispiel Ergebnis

<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
Trainieren Sie die Datenanalyse mit mehreren Sätzen von Ein- und Ausgängen.

Parameters

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

Beispiel

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

Sie können jede der oben genannten APIs mit JSON anstelle von XML mit dem Endpunkt aufrufen. /rest/json Statt /rest/api.