Być bot-dostawcy z bot bot Libre platformy chmurowej
Dokumenty : Web API

Web API

Oprócz możliwości umieszczenia swojej Czat boty na swoją stronę, i otworzyć ich z dowolnego urządzenia z systemem Android lub iOS, można również uzyskać dostęp do czatu botami przez BOT Libre web API. Web API daje przewagę mieć pełną kontrolę nad komputerem interfejs bota.

Można użyć interfejsu API sieci web, aby uzyskać dostęp do bot ze swojej własnej strony za pomocą JavaScript, PHP, lub dowolny inny język. Możesz także korzystać z web API do tworzenia własnych aplikacji mobilnych w celu uzyskania dostępu do BOT, takich jak aplikacje dla systemu Android lub iOS.

Web API to zestaw żądanie HTTP GET/post Uri, które umożliwiają wysyłanie i odbieranie wiadomości danych. Podczas przeglądania strony internetowej, przeglądarka robi serię żądanie HTTP GET/POST-wnioski do URI, które zwracają zawartości HTML. W usłudze internetowej URI, które zwracają XML lub JSON-dane, a nie HTML.

Bot Libre web API udostępnia trzy interfejs API REST w jednym. Pierwszy to zbiór żądanie HTTP GET-URI, które akceptują formy, i zwracać dane w formacie XML. Drugi zestaw API weźmiemy dane żądania HTTP POST XML i zwraca dane w formacie XML. Trzeci zestaw API weźmiemy dane żądania HTTP POST JSON i zwracać JSON.

Większość aplikacji będzie korzystać z XML-komunikat API, ale niektóre aplikacje mogą używać forma uzyskania API ze względu na swoją prostotę. Interfejsy API są identyczne innym, niż ich mechanizm.


Rozmowy API URL punktów końcowych

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.

API niestandardowego adresu URL punktów końcowych

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 punktów końcowych

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

Punkty końcowe adresu URL interfejsu API czatu na żywo

URL Operation Type Description
/rest/api/get-channel-bot-mode POST XML Get channel bot mode.
/rest/api/save-channel-bot-mode POST XML Save channel bot mode.
/rest/api/create-channel-attachment POST XML Create a channel attachmemt
/rest/api/create-channel POST XML Create channel.
/rest/api/update-channel POST XML Update channel.
/rest/api/get-bot-channel POST XML Get bot channel.
/rest/api/get-user-channel POST XML Get user channel.
/rest/api/get-channels POST XML Retrieve all channels.
/rest/api/get-channel-users POST XML Get all users of a selected channel.
/rest/api/get-channel-admins POST XML Get all admins of a channel.
/rest/api/update-channel-icon POST XML Update the icon of the channel.
/rest/api/thumbs-up-channel POST XML Thumbs up a channel.
/rest/api/thumbs-down-channel POST XML Thumbs down a channel.
/rest/api/flag-channel POST XML Flag a channel.
/rest/api/star-channel POST XML Star a channel channel.
/rest/api/delete-channel POST XML Delete channel.
/rest/api/check-channel POST XML Check to validate and returns a channel.

Forum API URL punktów końcowych

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.

API skryptu URL punktów końcowych

URL Operation Type Description
/rest/api/get-scripts POST XML Retrieve the scripts.
/rest/api/get-script-users POST XML Get users of a script.
/rest/api/get-script-admins POST XML Get admins of a script.
/rest/api/create-script POST XML Create a new script.
/rest/api/update-script POST XML Update the contents of the script.
/rest/api/update-script-icon POST XML Update the icon of the script.
/rest/api/check-script POST XML Check to validate and returns a script.
/rest/api/delete-script POST XML Delete a script.
/rest/api/flag-script POST XML Flag a script.
/rest/api/thumbs-up-script POST XML Placing a thumbs up to a script.
/rest/api/thumbs-down-script POST XML Placing a thumbs down to a script.
/rest/api/star-script POST XML Placing a star to a script.

Avatar API URL punktów końcowych

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

Domena URL punktów końcowych

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.

Grafika URL punktów końcowych

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.

Punkty końcowe adresu URL analizy

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.

Rozmowy API URL punktów końcowych

Form Chat

URI: https://www.botlibre.com/rest/api/form-chat
Operation: GET
Type: Form
Formie chat API dostaje komunikat i zwraca odpowiedź na czat bota jako dokument XML.

Parameters

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

Przykład

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


Przykładowe Wyniki

<?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
Chat API dostaje komunikat i zwraca odpowiedź na czat bota jako dokument XML.

Parameters

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

Przykład

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


Przykładowe Wyniki

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


JSON Chat

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

Parameters

Parameter Required Type Description




API niestandardowego adresu URL punktów końcowych

Form-Check-User

URI: https://www.botlibre.com/rest/api/form-check-user
Operation: GET
Type: Form
Interfejs API użytkownika sprawdzania poprawności formularza sprawdza poprawność użytkownika i zwraca szczegóły użytkownika.

Parameters

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

Przykład

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


Przykładowe Wyniki

<?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
Interfejs API użytkownika sprawdzania sprawdza poprawność użytkownika i zwraca szczegóły użytkownika.

Parameters

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

Przykład

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


Przykładowe Wyniki

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



Bot API URL punktów końcowych

Get-Bots

URI: https://www.botlibre.com/rest/api/get-bots
Operation: POST
Type: XML
Interfejs API get-bots używany do pobierania wszystkich dostępnych botów.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is getting the users. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
attribute Filter all the private bot items.
type
attribute Type of bot.
typeFilter
attribute Filter type of bot.
userFilter
attribute Filter by users.
tag
attribute Filter by tag.
category
attribute Filter by category.
filter
attribute Filter by name or description keywords.
contentRating
attribute Filter by content rating.
restrict
attribute Filter restriction.
sort
attribute Sort condition.
page
attribute Result page.



Get-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/get-bot-script-source
Operation: POST
Type: XML
Interfejs API get-bot-script-source używany do uzyskania źródła skryptu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the bot.



Delete-Bot-Script

URI: https://www.botlibre.com/rest/api/delete-bot-script
Operation: POST
Type: XML
Interfejs API delete-bot-script używany do usuwania skryptu z bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the bot.



Import-Bot-Script

URI: https://www.botlibre.com/rest/api/import-bot-script
Operation: POST
Type: XML
Interfejs API import-bot-script używany do importowania skryptu do bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the bot.



Import-Bot-Log

URI: https://www.botlibre.com/rest/api/import-bot-log
Operation: POST
Type: XML
Interfejs API import-bot-log używany do importowania dzienników bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the bot.



Save-Bot-Avatar

URI: https://www.botlibre.com/rest/api/save-bot-avatar
Operation: POST
Type: XML
Interfejs API save-bot-avatar służy do wybierania awatara i zapisywania dla bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation.
id
attribute Bot's ID.
password
attribute The password of the user who is creating the instance.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instanceAvatar
attribute Instance avatar.



Save-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/save-bot-script-source
Operation: POST
Type: XML
Interfejs API save-bot-script-source używany do wybierania skryptu i zapisywania dla bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Scripts's ID.
source
Script source code to update.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the bot.



Create-Bot-Attachment

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

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user perforing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the bot attachment.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the bot.
name
attribute Attachment name.
type
attribute Attachment type.
file
file Bot attachment file.



Up-Bot-Script

URI: https://www.botlibre.com/rest/api/up-bot-script
Operation: POST
Type: XML
Interfejs API up-bot-script używany do przenoszenia skryptu bota w górę.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the bot.



Down-Bot-Script

URI: https://www.botlibre.com/rest/api/down-bot-script
Operation: POST
Type: XML
Interfejs API down-bot-script używany do przenoszenia w dół skryptu bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the bot.



Get-Instances

URI: https://www.botlibre.com/rest/api/get-instances
Operation: POST
Type: XML
Interfejs API get-instances pobierze wszystkie dostępne wystąpienia.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
Filter all the private instance items.
type
Type of instance.
typeFilter
Filter type of instance.
userFilter
Filter by user.
tag
Filter by tag.
category
Filter by category.
contentRating
Filter by content rating.
restrict
Filter restriction.
sort
Sort condition.
page
attribute Result page.



Get-Instance-Users

URI: https://www.botlibre.com/rest/api/get-instance-users
Operation: POST
Type: XML
Interfejs API get-instance-users pobierze wszystkich użytkowników tego wystąpienia bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot's ID.
user
attribute The ID of the user performing the operation.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Instance-Admins

URI: https://www.botlibre.com/rest/api/get-instance-admins
Operation: POST
Type: XML
Interfejs API get-instance-admins pobierze wszystkich administratorów tej instancji bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot's ID.
user
attribute The ID of the user performing the operation.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-All-Instances

URI: https://www.botlibre.com/rest/api/get-all-instances
Operation: POST
Type: XML
Interfejs API form-get-all-instances odpytuje szczegóły dla wszystkich wystąpień bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
Filter all the private instance items.
type
Type of instance.
typeFilter
Filter type of instance.
userFilter
Filter by user.
tag
Filter by tag.
category
Filter by category.
contentRating
Filter by content rating.
restrict
Filter restriction.
sort
Sort condition.
page
attribute Result page.

Przykład

<browse application="1234567890"/>


Przykładowe Wyniki

<?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
Interfejs API wystąpienia sprawdzania sprawdza, czy istnieje identyfikator lub nazwa bota, i zwraca szczegóły bota.

Parameters

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

Przykład

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


Przykładowe Wyniki

<?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
Interfejs API wystąpienia sprawdzania formularza sprawdza, czy istnieje identyfikator lub nazwa bota, i zwraca szczegóły bota.

Parameters

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

Przykład

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


Przykładowe Wyniki

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


Form-Get-All-Instances

URI: https://www.botlibre.com/rest/api/form-get-all-instances
Operation: GET
Type: Form
Interfejs API form-get-all-instances odpytuje szczegóły dla wszystkich wystąpień bota.

Parameters

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

Przykład

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


Przykładowe Wyniki

<?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
Interfejs API instancji aktualizacji może pozwolić użytkownikowi aktualizować całą zawartość wybranej instancji bota

Parameters

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



Update-Instance-Icon

URI: https://www.botlibre.com/rest/api/update-instance-icon
Operation: POST
Type: XML
Interfejs API update-instance-icon pozwala użytkownikowi zmienić ikonę instancji bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
file
file The icon image file



Create-Instance

URI: https://www.botlibre.com/rest/api/create-instance
Operation: POST
Type: XML
Interfejs API tworzenia instancji do tworzenia nowego wystąpienia bota.

Parameters

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



Delete-Instance

URI: https://www.botlibre.com/rest/api/delete-instance
Operation: POST
Type: XML
Interfejs API wystąpienia usuwania do usuwania wystąpienia bota.

Parameters

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



Flag-Instance

URI: https://www.botlibre.com/rest/api/flag-instance
Operation: POST
Type: XML
Interfejs API instancji flagi Oflaguj wystąpienie bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot's ID.
user
attribute The ID of the user who performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason
element Flagged Reason.



Star-Instance

URI: https://www.botlibre.com/rest/api/star-instance
Operation: POST
Type: XML
Interfejs API instancji gwiazdy jest gwiazdką instancji bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
stars
attribute Stars.



Train-Instance

URI: https://www.botlibre.com/rest/api/train-instance
Operation: POST
Type: XML
Interfejs API instancji pociągu trenuje instancję bota czatu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the opertaion. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the bot.
operation
attribute The training operation, one of AddGreeting, RemoveGreeting, AddDefaultResponse, RemoveDefaultResponse, AddResponse.
question
element The training question text.
response
element The training response text.



Thumbs-Up-Instance

URI: https://www.botlibre.com/rest/api/thumbs-up-instance
Operation: POST
Type: XML
Interfejs API instancji kciuka w górę użytkownik może umieścić kciuk w górę do instancji bota czatu.

Parameters

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



Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-instance
Operation: POST
Type: XML
Instancja kciuka w dół, w przypadku gdy użytkownik może umieścić kciuk w dół do instancji chat bota

Parameters

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




Punkty końcowe adresu URL interfejsu API czatu na żywo

Get-Channel-Bot-Mode

URI: https://www.botlibre.com/rest/api/get-channel-bot-mode
Operation: POST
Type: XML
Interfejs API get-channel-bot-mode używał trybu bota kanału pobierania.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Channel id for validation.
user
attribute The ID of the user who is getting the channel of the bot. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private. The user/password are only required on the first message.
password
attribute The password of the user. A token can also be used.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Save Channel Bot Mode

URI: https://www.botlibre.com/rest/api/save-channel-bot-mode
Operation: POST
Type: XML
Interfejs API trybu save-channel-bot-mode używany do zapisywania trybu bota kanału.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
instance
attribute The ID of the channel.
user
attribute The ID of the user who is saving the channel of the bot. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private. The user/password are only required on the first message.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
bot
attribute The instance of the Bot.
mode
attribute The mode of the Bot.



Create channel attachment

URI: https://www.botlibre.com/rest/api/create-channel-attachment
Operation: POST
Type: XML
Używany interfejs API tworzenia załączników kanałów umożliwia utworzenie załącznika dla kanału.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user creating the channel attachment. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the channel attachment.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the channel.
name
attribute Attachment name.
type
attribute Attachment type.
file
file Channel attachment file.



Create Channel

URI: https://www.botlibre.com/rest/api/create-channel
Operation: POST
Type: XML
Interfejs API tworzenia kanału używany do tworzenia nowego kanału.

Parameters

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



Create Channel

URI: https://www.botlibre.com/rest/api/update-channel
Operation: POST
Type: XML
Interfejs API kanału aktualizacji używany do aktualizowania istniejącego kanału.

Parameters

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



Get bot channel

URI: https://www.botlibre.com/rest/api/get-bot-channel
Operation: POST
Type: XML
Interfejs API get-bot-channel używany do pobierania kanału bota.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Bot id for validation.
user
attribute The ID of the user getting the channel of the bot.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
channelType
attribute Channel type.



Get user channel

URI: https://www.botlibre.com/rest/api/get-user-channel
Operation: POST
Type: XML
Interfejs API get-user-channel używany do pobierania kanału użytkownika.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who's channel to get.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
channelType
attribute Channel type.



Get Channels

URI: https://www.botlibre.com/rest/api/get-channels
Operation: POST
Type: XML
Interfejs API get-channels używany do pobierania wszystkich dostępnych kanałów.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user who is retrieving all the channels. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
Filter all the private channel items.
filterAdult
Filter all adult channel items.
type
Type of channel.
typeFilter
Filter type of channel.
userFilter
Filter by users.
tag
attribute Filter by tag.
category
attribute Filter by category.
filter
attribute Filter by name or description keywords.
contentRating
attribute Filter by content rating.
restrict
attribute Filter restriction.
sort
attribute Sort condition.
page
attribute Result page.



Get channel users

URI: https://www.botlibre.com/rest/api/get-channel-users
Operation: POST
Type: XML
Interfejs API get-channel-users używany do zwracania wszystkich użytkowników wybranego kanału.

Parameters

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



Get Channel Admins

URI: https://www.botlibre.com/rest/api/get-channel-admins
Operation: POST
Type: XML
Interfejs API get-channel-admins używany do zwracania wszystkich administratorów wybranego kanału.

Parameters

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



Update Channel Icon

URI: https://www.botlibre.com/rest/api/update-channel-icon
Operation: POST
Type: XML
Interfejs API update-channel-icon używany do aktualizacji ikony kanału.

Parameters

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



Thumbs Up Channel

URI: https://www.botlibre.com/rest/api/thumbs-up-channel
Operation: POST
Type: XML
Interfejs API kanału "kciuk w górę" umożliwia użytkownikom umieszczanie kciuków w górę kanału.

Parameters

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



Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-channel
Operation: POST
Type: XML
Interfejs API kanału "kciuk w górę" umożliwiał użytkownikom umieszczanie kciuków w dół kanału.

Parameters

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



Flag-Channel

URI: https://www.botlibre.com/rest/api/flag-channel
Operation: POST
Type: XML
Interfejs API kanału flagi używany do oznaczania kanału.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Channel id for validation.
user
attribute The ID of the user who is flagging a channel. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason
element Flagged Reason.



Star-Channel

URI: https://www.botlibre.com/rest/api/star-channel
Operation: POST
Type: XML
Interfejs API kanału gwiazdkowego używany do oznaczania kanału gwiazdką.

Parameters

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



Delete-Channel

URI: https://www.botlibre.com/rest/api/delete-channel
Operation: POST
Type: XML
Interfejs API kanału usuwania użyty do usunięcia kanału.

Parameters

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



Check-Channel

URI: https://www.botlibre.com/rest/api/check-channel
Operation: POST
Type: XML
Interfejs API check-channel używany do sprawdzania poprawności i zwracania kanału.

Parameters

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




Forum API URL punktów końcowych

Get-Forums

URI: https://www.botlibre.com/rest/api/get-forums
Operation: POST
Type: XML
Interfejs API get-forums używany do pobierania dostępnych forów.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
attribute Filter all the private forums items.
type
attribute Type of forums.
typeFilter
attribute Filter type of forums.
userFilter
attribute Filter by users.
tag
attribute Filter by tag.
category
attribute Filter by category.
filter
attribute Filter by name or description keywords.
contentRating
attribute Filter by content rating.
restrict
attribute Filter restriction.
sort
attribute Sort condition.
page
attribute Result page.



Get-Forum-Posts

URI: https://www.botlibre.com/rest/api/get-forum-posts
Operation: POST
Type: XML
Interfejs API get-forum-posts używany do pobierania dostępnych postów z każdego forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
attribute Filter all the private posts.
type
attribute Type of forums.
typeFilter
attribute Filter type of forum posts.
userFilter
attribute Filter by users.
tag
attribute Filter by tag.
category
attribute Filter by category.
filter
attribute Filter by name or description keywords.
contentRating
attribute Filter by content rating.
restrict
attribute Filter restriction.
sort
attribute Sort condition.
page
attribute Result page.



Get-Forum-Users

URI: https://www.botlibre.com/rest/api/get-forum-users
Operation: POST
Type: XML
Interfejs API get-forum-users używany do pobierania użytkowników każdego forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Forum-Admins

URI: https://www.botlibre.com/rest/api/get-forum-admins
Operation: POST
Type: XML
Interfejs API get-forum-admins używany do pobierania administratorów każdego forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Save-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Get-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Create-Forum

URI: https://www.botlibre.com/rest/api/create-forum
Operation: POST
Type: XML
Interfejs API create-forum do tworzenia nowego forum.

Parameters

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



Create-Forum-Attachment

URI: https://www.botlibre.com/rest/api/create-forum-attachment
Operation: POST
Type: XML
Interfejs API create-forum-attachment do tworzenia forum zawierającego załącznik.

Parameters

Parameter Required Type Description
application
attribute Your application ID
instance
Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
file
Forum file.
name
Attachment name.
type
Attachment type.



Create-Forum-Post

URI: https://www.botlibre.com/rest/api/create-forum-post
Operation: POST
Type: XML
Interfejs API create-forum-post do tworzenia nowego wpisu na forum.

Parameters

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



Update-Forum

URI: https://www.botlibre.com/rest/api/update-forum
Operation: POST
Type: XML
Interfejs API update-forum używany do aktualizacji zawartości forum.

Parameters

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



Update-Forum-Post

URI: https://www.botlibre.com/rest/api/update-forum-post
Operation: POST
Type: XML
Interfejs API update-forum-post aktualizuje zawartość wpisu na forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the forum.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
replies
Post replies.
isFeatured
attribute Featured forum.
topic
Post's topic
details
Post's text content
tags
Post's tags, csv



Update-Forum-Icon

URI: https://www.botlibre.com/rest/api/update-forum-icon
Operation: POST
Type: XML
Update-forum-icon API służy do zmiany ikony fourm.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
file
file Icon image file.



Check-Forum

URI: https://www.botlibre.com/rest/api/check-forum
Operation: POST
Type: XML
Interfejs API forum sprawdzania poprawności i zwraca forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Check-Forum-Post

URI: https://www.botlibre.com/rest/api/check-forum-post
Operation: POST
Type: XML
Interfejs API check-forum-post sprawdza wpis na forum, aby sprawdzić poprawność i zwraca wpis z forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Forum

URI: https://www.botlibre.com/rest/api/delete-forum
Operation: POST
Type: XML
Interfejs API usuwania forum do usuwania forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Forum-Post

URI: https://www.botlibre.com/rest/api/delete-forum-post
Operation: POST
Type: XML
Interfejs API delete-forum-post jest wpisem na forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Forum

URI: https://www.botlibre.com/rest/api/flag-forum
Operation: POST
Type: XML
Interfejs API flag-forum używany do oznaczania forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason
element Flagged Reason.



Flag-Forum-Post

URI: https://www.botlibre.com/rest/api/flag-forum-post
Operation: POST
Type: XML
Flaga interfejsu API flag-forum-post jest wpisem forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason
element Flagged Reason.



Thumbs-Up-Forum

URI: https://www.botlibre.com/rest/api/thumbs-up-forum
Operation: POST
Type: XML
Interfejs API thumbs-up-forum używany do umieszczania kciuków w górę na forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Forum

URI: https://www.botlibre.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
Interfejs API thumbs-down-forum używany do umieszczania kciuków w dół na forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute TThe ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Subscribe-Forum

URI: https://www.botlibre.com/rest/api/subscribe-forum
Operation: POST
Type: XML
Interfejs API forum subskrybowania ma umożliwić użytkownikowi subskrybowanie forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Unsubscribe-Forum

URI: https://www.botlibre.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML
Interfejs API rezygnacji z subskrypcji forum ma umożliwić użytkownikowi rezygnację z subskrypcji forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Star-Forum

URI: https://www.botlibre.com/rest/api/star-forum
Operation: POST
Type: XML
Interfejs API star-forum ma umożliwić użytkownikowi umieszczenie gwiazdki na forum.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Forum's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
stars
attribute Stars.




API skryptu URL punktów końcowych

Get-Scripts

URI: https://www.botlibre.com/rest/api/get-scripts
Operation: POST
Type: XML
Interfejs API get-scripts używany do pobierania dostępnych skryptów.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
Filter all the private script items.
filterAdult
Filter all adult script items.
type
Type of script.
typeFilter
Filter type of script.
userFilter
Filter by users.
tag
attribute Filter by tag.
category
attribute Filter by category.
filter
attribute Filter by name or description keywords.
contentRating
attribute Filter by content rating.
restrict
attribute Filter restriction.
sort
attribute Sort condition.
page
attribute Result page.



Get-Script-Users

URI: https://www.botlibre.com/rest/api/get-script-users
Operation: POST
Type: XML
Interfejs API get-script-users używany do pobierania użytkowników skryptu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Script-Admins

URI: https://www.botlibre.com/rest/api/get-script-admins
Operation: POST
Type: XML
Interfejs API get-script-admins służy do pobierania wszystkich administratorów skryptu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Create-Script

URI: https://www.botlibre.com/rest/api/create-script
Operation: POST
Type: XML
Interfejs API skryptu tworzenia służy do tworzenia nowego skryptu.

Parameters

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



Update-Script

URI: https://www.botlibre.com/rest/api/update-script
Operation: POST
Type: XML
Interfejs API skryptu aktualizacji używany do aktualizowania zawartości skryptu.

Parameters

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



Update-Script-Icon

URI: https://www.botlibre.com/rest/api/update-script-icon
Operation: POST
Type: XML
Interfejs API update-script-icon używany do zmiany ikony skryptu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
file
file Icon image file.



Check-Script

URI: https://www.botlibre.com/rest/api/check-script
Operation: POST
Type: XML
Check-forum API sprawdza poprawność i zwraca skrypt.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Script

URI: https://www.botlibre.com/rest/api/delete-script
Operation: POST
Type: XML
Interfejs API skryptu do usuwania skryptu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Script

URI: https://www.botlibre.com/rest/api/flag-script
Operation: POST
Type: XML
Interfejs API skryptu flagi używany do oznaczania skryptu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Up-Script

URI: https://www.botlibre.com/rest/api/thumbs-up-script
Operation: POST
Type: XML
Interfejs API thumbs-up-forum używany do umieszczania kciuka w górę do skryptu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Script

URI: https://www.botlibre.com/rest/api/thumbs-down-script
Operation: POST
Type: XML
Interfejs API forum kciuk w dół używany do umieszczania kciuków w dół do skryptu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Star-Script

URI: https://www.botlibre.com/rest/api/star-script
Operation: POST
Type: XML
Interfejs API star-forum umożliwia użytkownikowi umieszczenie gwiazdki w skrypcie.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Script's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.




Avatar API URL punktów końcowych

Get-Avatars

URI: https://www.botlibre.com/rest/api/get-avatars
Operation: POST
Type: XML
Interfejs API get-avatars służy do pobierania dostępnych awatarów.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
Filter all the private avatar items.
filterAdult
Filter all adult avatar items.
type
Type of avatar.
typeFilter
Filter type of avatar.
userFilter
Filter by users.
tag
attribute Filter by tag.
category
attribute Filter by category.
filter
attribute Filter by name or description keywords.
contentRating
attribute Filter by content rating.
restrict
attribute Filter restriction.
sort
attribute Sort condition.
page
attribute Result page.



Get-Avatar-Users

URI: https://www.botlibre.com/rest/api/get-avatar-users
Operation: POST
Type: XML
Interfejs API get-avatars-users używany do pobierania wszystkich użytkowników powiązanych z tym awatarem.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Avatar-Admins

URI: https://www.botlibre.com/rest/api/get-avatar-admins
Operation: POST
Type: XML
Interfejs API get-avatar-admins używany do pobierania wszystkich administratorów wybranego awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Avatar-Media

URI: https://www.botlibre.com/rest/api/get-avatar-media
Operation: POST
Type: XML
Interfejs API get-avatar-media używany do pobierania multimediów awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Create-Avatar

URI: https://www.botlibre.com/rest/api/create-avatar
Operation: POST
Type: XML
Interfejs API tworzenia awatara używany do tworzenia nowego awatara.

Parameters

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



Create-Avatar-Media

URI: https://www.botlibre.com/rest/api/create-avatar-media
Operation: POST
Type: XML
Interfejs API create-avatar-media używany do tworzenia multimediów dla awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the avatar.
name
attribute Name of the media file.
type
attribute Type of the avatar media file.
file
file Media file.



Save-Avatar-Media

URI: https://www.botlibre.com/rest/api/save-avatar-media
Operation: POST
Type: XML
Interfejs API save-avatar-media używany do zapisywania zmian bieżących multimediów awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
mediaId
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
domain
attribute Domain.
instance
attribute The ID of the avatar.
name
attribute Name of the media.
type
attribute Type of the avatar media.
emotions
attribute Emotions of the avatar.
actions
attribute Actions of the avatar.
poses
attribute Poses of the avatar.
hd
attribute HD type of media.
talking
attribute Talking state of the avatar.



Save-Avatar-Background

URI: https://www.botlibre.com/rest/api/save-avatar-background
Operation: POST
Type: XML
Interfejs API zapisz-awatar-tło zapisuje obraz tła awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
domain
attribute Domain.
instance
attribute The ID of the avatar.
name
attribute Name of the media file.
type
attribute Type of the avatar media file.
file
file Background image file.



Delete-Avatar

URI: https://www.botlibre.com/rest/api/delete-avatar
Operation: POST
Type: XML
Interfejs API usuwania awatara używany do usuwania wybranego awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Delete-Avatar-Media

URI: https://www.botlibre.com/rest/api/delete-avatar-media
Operation: POST
Type: XML
Interfejs API delete-avatar-media używany do usuwania multimediów awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
mediaId
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the avatar.



Delete-Avatar-Background

URI: https://www.botlibre.com/rest/api/delete-avatar-background
Operation: POST
Type: XML
Interfejs API delete-avatar-background używany do usuwania obrazu tła awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Check-Avatar

URI: https://www.botlibre.com/rest/api/check-avatar
Operation: POST
Type: XML
Interfejs API check-avatar służy do sprawdzania poprawności i zwracania awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Avatar-Message

URI: https://www.botlibre.com/rest/api/avatar-message
Operation: POST
Type: XML
Interfejs API wiadomości awatara

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation.
password
attribute Password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
message
element Message.
avatar
attribute Avatar id.
avatar
attribute The avatar.
emote
attribute The emote for the message.
action
attribute The actoin for the message.
pose
attribute The pose for the message.
speak
attribute Speak.
voice
attribute Voice used for the message.
voiceMode
attribute Voice mode for the message.
format
attribute Message format.
hd
attribute HD.



Star-Avatar

URI: https://www.botlibre.com/rest/api/star-avatar
Operation: POST
Type: XML
Interfejs API awatara gwiazdy używany przez użytkownika do gwiazdorowania awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
stars
attribute Stars.



Flag-Avatar

URI: https://www.botlibre.com/rest/api/flag-avatar
Operation: POST
Type: XML
Interfejs API flagi-awatara używany do oznaczania awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason
element Flagged Reason.



Init-Avatar

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

Parameters

Parameter Required Type Description



Update-Avatar

URI: https://www.botlibre.com/rest/api/update-avatar
Operation: POST
Type: XML
Interfejs API awatara aktualizacji używany do aktualizowania i zmieniania zawartości awatara.

Parameters

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



Update-Avatar-Icon

URI: https://www.botlibre.com/rest/api/update-avatar-icon
Operation: POST
Type: XML
Interfejs API update-avatar-icon używany do aktualizacji ikony awatara

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
file
file Icon image file.



Thumbs-Up-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-up-avatar
Operation: POST
Type: XML
Interfejs API kciuka w górę awatara używany do umieszczania kciuka w górę na wybranym awatarze.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-down-avatar
Operation: POST
Type: XML
Interfejs API kciuka w dół-awatara używany do umieszczania kciuka w dół do wybranego awatara.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Avatar's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.




Domena URL punktów końcowych

Get-Domains

URI: https://www.botlibre.com/rest/api/get-domains
Operation: POST
Type: XML
Interfejs API get-domains używany do pobierania wszystkich dostępnych domen.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
Filter all the private domain items.
filterAdult
Filter all adult domain items.
type
Type of domain.
typeFilter
Filter type of domain.
userFilter
Filter by users.
tag
attribute Filter by tag.
category
attribute Filter by category.
filter
attribute Filter by name or description keywords.
contentRating
attribute Filter by content rating.
restrict
attribute Filter restriction.
sort
attribute Sort condition.
page
attribute Result page.



Get-Domain-Users

URI: https://www.botlibre.com/rest/api/get-domain-users
Operation: POST
Type: XML
Interfejs API get-domain-users używany do pobierania wszystkich użytkowników domeny.

Parameters

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



Get-Domain-Admins

URI: https://www.botlibre.com/rest/api/get-domain-admins
Operation: POST
Type: XML
Interfejs API get-domain-admins używany do pobierania wszystkich administratorów domeny.

Parameters

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



Get-Domain

URI: https://www.botlibre.com/rest/api/get-domain
Operation: POST
Type: XML
Interfejs API pobierania domeny pobiera wybraną domenę.

Parameters

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



Get-Domain-Icon

URI: https://www.botlibre.com/rest/api/get-domain-icon
Operation: POST
Type: XML
Interfejs API get-domain-icon używany do zwracania ikony domeny.

Parameters

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



Create-Domain

URI: https://www.botlibre.com/rest/api/create-domain
Operation: POST
Type: XML
Interfejs API tworzenia domeny tworzy nową domenę.

Parameters

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



Check-Domain

URI: https://www.botlibre.com/rest/api/check-domain
Operation: POST
Type: XML
Interfejs API domeny kontrolnej używany do sprawdzania poprawności i zwracania domeny z powrotem.

Parameters

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



Update-Domain

URI: https://www.botlibre.com/rest/api/update-domain
Operation: POST
Type: XML
Interfejs API domeny aktualizacji aktualizuje zawartość domeny.

Parameters

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



Delete-Domain

URI: https://www.botlibre.com/rest/api/delete-domain
Operation: POST
Type: XML
Interfejs API usuwania domeny usuwa wybraną domenę.

Parameters

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



Flag-Domain

URI: https://www.botlibre.com/rest/api/flag-domain
Operation: POST
Type: XML
Interfejs API domeny flagi używany do oznaczania domeny.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason
element Flagged Reason.



Star-Domain

URI: https://www.botlibre.com/rest/api/star-domain
Operation: POST
Type: XML
Interfejs API domeny gwiazd używanej do umieszczania gwiazdki w domenie.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Domain's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
stars
attribute Stars.



Thumbs-Up-Domain

URI: https://www.botlibre.com/rest/api/thumbs-up-domain
Operation: POST
Type: XML
Interfejs API domeny kciuka w górę używany do kciuka w górę domeny.

Parameters

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



Thumbs-Down-Domain

URI: https://www.botlibre.com/rest/api/thumbs-down-domain
Operation: POST
Type: XML
Interfejs API domeny kciuka w dół używany do ściągnęć kciukiem w dół do wybranej domeny.

Parameters

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




Grafika URL punktów końcowych

Get-Graphics

URI: https://www.botlibre.com/rest/api/get-graphics
Operation: POST
Type: XML
Interfejs API pobierania grafiki pobiera wszystkie dostępne grafiki.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
Filter all the private graphic items.
filterAdult
Filter all adult graphic items.
type
Type of graphic.
typeFilter
Filter type of graphic.
userFilter
Filter by users.
tag
attribute Filter by tag.
category
attribute Filter by category.
filter
attribute Filter by name or description keywords.
contentRating
attribute Filter by content rating.
restrict
attribute Filter restriction.
sort
attribute Sort condition.
page
attribute Result page.



Get-Graphic-Users

URI: https://www.botlibre.com/rest/api/get-graphic-users
Operation: POST
Type: XML
Interfejs API get-graphic-users zwraca wszystkich użytkowników wybranej grafiki.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Graphic-Admins

URI: https://www.botlibre.com/rest/api/get-graphic-admins
Operation: POST
Type: XML
Interfejs API get-graphic-admins zwraca wszystkich administratorów wybranej grafiki.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Update-Graphic

URI: https://www.botlibre.com/rest/api/update-graphic
Operation: POST
Type: XML
Interfejs API update-graphic używany do aktualizowania zawartości grafiki.

Parameters

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



Update-Graphic-Icon

URI: https://www.botlibre.com/rest/api/update-graphic-icon
Operation: POST
Type: XML
Interfejs API update-graphic-icon używany do zmiany i aktualizacji ikony graficznej.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
file
file Icon image file.



Update-Graphic-Media

URI: https://www.botlibre.com/rest/api/update-graphic-media
Operation: POST
Type: XML
Interfejs API update-graphic-media używany do aktualizacji zawartości multimedialnej wybranej grafiki.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
id
attribute Graphic's ID.
password
attribute The password of the user who is creating the domain.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
fileName
attribute File name of the graphic.
fileType
attribute File type of the graphic.
file
file Graphic file.



Create-Graphic

URI: https://www.botlibre.com/rest/api/create-graphic
Operation: POST
Type: XML
Interfejs API create-graphic używany do tworzenia nowej grafiki.

Parameters

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



Delete-Graphic

URI: https://www.botlibre.com/rest/api/delete-graphic
Operation: POST
Type: XML
Interfejs API usuwania grafiki używany do usuwania wybranej grafiki.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Check-Graphic

URI: https://www.botlibre.com/rest/api/check-graphic
Operation: POST
Type: XML
Interfejs API grafiki kontrolnej używany do sprawdzania poprawności grafiki i zwracania jej z powrotem.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Flag-Graphic

URI: https://www.botlibre.com/rest/api/flag-graphic
Operation: POST
Type: XML
Interfejs API flagi-grafika używany do oznaczania grafiki.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason
element Flagged Reason.



Star-Graphic

URI: https://www.botlibre.com/rest/api/star-graphic
Operation: POST
Type: XML
Interfejs API star-graphic służył do umieszczania gwiazdy na grafice.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
stars
attribute Stars.



Thumbs-Up-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-up-graphic
Operation: POST
Type: XML
Interfejs API kciuka w górę używany do umieszczania kciuka w górę na wybranej grafice.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-down-graphic
Operation: POST
Type: XML
Interfejs API kciuka w dół używany do umieszczania kciuka w dół do wybranej grafiki.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Graphic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.




Punkty końcowe adresu URL analizy

Get-Analytics

URI: https://www.botlibre.com/rest/api/get-analytics
Operation: POST
Type: XML
Interfejs API get-analytics używany do pobierania wszystkich dostępnych analiz.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate
attribute Filter all the private analytic items.
filterAdult
attribute Filter all adult analytic items.
type
attribute Type of analytics.
typeFilter
attribute Filter type of analytic.
userFilter
attribute Filter by users.
tag
attribute Filter by tag.
category
attribute Filter by category.
filter
attribute Filter by name or description keywords.
contentRating
attribute Filter by content rating.
restrict
attribute Filter restriction.
sort
attribute Sort condition.
page
attribute Result page.



Get-Analytic-Users

URI: https://www.botlibre.com/rest/api/get-analytic-users
Operation: POST
Type: XML
Interfejs API get-analytic-users używany do pobierania wszystkich użytkowników analizy.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Get-Analytic-Admins

URI: https://www.botlibre.com/rest/api/get-analytic-admins
Operation: POST
Type: XML
Interfejs API get-analytic-admins używany do pobierania wszystkich administratorów wybranego narzędzia analitycznego.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Test-Analytic

URI: https://www.botlibre.com/rest/api/test-analytic
Operation: POST
Type: XML
Interfejs API analizy testowej używany do testowania wyszkolonego modelu analitycznego z określonymi instrukcjami.

Parameters

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



Test-Audio-Analytic

URI: https://www.botlibre.com/rest/api/test-audio-analytic
Operation: POST
Type: XML
Test-audio-analityczny interfejs API używany do testowania analitycznego modelu audio.

Parameters

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



Test-Object-Detection-Analytic

URI: https://www.botlibre.com/rest/api/test-object-detection-analytic
Operation: POST
Type: XML
Interfejs API test-object-detection-analytic używany do testowania modelu analitycznego wykrywania obiektów z określonymi instrukcjami.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute The ID of the Analytic.
file
file Image to test for the object detection analytic.



Get-Test-Media-Result

URI: https://www.botlibre.com/rest/api/get-test-media-result
Operation: POST
Type: XML
Interfejs API get-test-media-result pobiera wyniki nośników testowych.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Report-Media-Analytic

URI: https://www.botlibre.com/rest/api/report-media-analytic
Operation: POST
Type: XML
Interfejs API report-media-analytic używany do uzyskania analitycznego reprot.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
processingTestMediaStatus
attribute Analytic test media status.



Train-Analytic

URI: https://www.botlibre.com/rest/api/train-analytic
Operation: POST
Type: XML
Interfejs API analizy pociągu używany do trenowania modelu analitycznego.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
trainingStatus
attribute Analytic training status.
cycles
attribute Analytic training cycles.



Delete-Analytic-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-media
Operation: POST
Type: XML
Interfejs API delete-analytic-media używany do usuwania wybranych nośników analitycznych.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
mediaId
attribute Analytic's media ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
label
attribute Analytic label.



Delete-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media
Operation: POST
Type: XML
Interfejs API delete-analytic-test-media używany do usuwania nośnika testowego analitycznego.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
mediaId
attribute Analytic's media ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
label
attribute Analytic label.



Get-Analytic-Media

URI: https://www.botlibre.com/rest/api/get-analytic-media
Operation: POST
Type: XML
Interfejs API get-analytic-media używany do pobierania wszystkich nośników analitycznych.

Parameters

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



Get-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/get-analytic-test-media
Operation: POST
Type: XML
Interfejs API get-analytic-test-media pobiera nośnik testowy analitycznego.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Create-Analytic-Label

URI: https://www.botlibre.com/rest/api/create-analytic-label
Operation: POST
Type: XML
Utwórz etykietę lub etykiety dla analitycznego. Każda etykieta jest klasyfikatorem. Każda etykieta jest taka, jakby opakowanie zawierało zestaw obrazów. Jest to wymagane przed rozpoczęciem fazy szkolenia w zakresie rozpoznawania obrazu. Każdy analityk musi mieć co najmniej dwie etykiety.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation.
password
attribute Password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute Analytic's ID.
label
attribute Analytic label.



Create-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/create-analytic-test-media-label
Operation: POST
Type: XML
Utwórz etykietę lub etykiety dla analitycznego. Każda etykieta jest klasyfikatorem. Każda etykieta jest taka, jakby opakowanie zawierało zestaw obrazów. Jest to wymagane przed rozpoczęciem fazy szkolenia w zakresie rozpoznawania obrazu. Każdy analityk musi mieć co najmniej dwie etykiety.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation.
password
attribute Password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
domain
attribute Domain.
instance
attribute Analytic's ID.
label
attribute Analytic label.



Delete-Analytic-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-label
Operation: POST
Type: XML
Interfejs API delete-analytic-label używany do usuwania wybranej etykiety obiektu analitycznego.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation.
password
attribute Password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute Analytic's ID.
label
attribute Analytic label.



Delete-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media-label
Operation: POST
Type: XML
Interfejs API delete-analytic-test-media-label używany do usuwania etykiety nośnika testowego analizy.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation.
password
attribute Password of the user.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
instance
attribute Analytic's ID.
label
attribute Analytic label.



Check-Training

URI: https://www.botlibre.com/rest/api/check-training
Operation: POST
Type: XML
Interfejs API szkolenia kontrolnego używany do pobierania niektórych informacji o bieżącym szkoleniu modelu.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
id
attribute Analytic's ID.
password
attribute The password of the user who is creating the analytic.
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Create-Analytic

URI: https://www.botlibre.com/rest/api/create-analytic
Operation: POST
Type: XML
Interfejs API create-analytic tworzy nowy interfejs analityczny.

Parameters

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



Update-Analytic

URI: https://www.botlibre.com/rest/api/update-analytic
Operation: POST
Type: XML
Interfejs API update-analytic aktualizuje lub zmienia szczegóły wybranego analitycznego.

Parameters

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



Flag-Analytic

URI: https://www.botlibre.com/rest/api/flag-analytic
Operation: POST
Type: XML
Interfejs API analizy flag używany do umieszczania flagi w interfejsie analitycznym.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason
element Flagged Reason.



Thumbs-Up-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-up-analytic
Operation: POST
Type: XML
Interfejs API analitycznego kciuka w górę używany do kciuka w górę analitycznego.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Thumbs-Down-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
Interfejs API analitycznego kciuka w dół używany do kciuka w dół do analitycznego.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Star-Analytic

URI: https://www.botlibre.com/rest/api/star-analytic
Operation: POST
Type: XML
Interfejs API star-analytic służy do gwiazdorowania obiektu analitycznego.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.
stars
attribute Stars.



Delete-Analytic

URI: https://www.botlibre.com/rest/api/delete-analytic
Operation: POST
Type: XML
Interfejs API analizy usuwania używany do usuwania wybranej analizy.

Parameters

Parameter Required Type Description
application
attribute Your application ID.
id
attribute Analytic's ID.
user
attribute The ID of the user performing the operation. The user must be registered with Bot Libre.
password
attribute The password of the user
token
attribute The token of the user. A token can be obtained through check-user, and is valid until reset.



Check-Analytic

URI: https://www.botlibre.com/rest/api/check-analytic
Operation: POST
Type: XML
Interfejs API check-analytic używany do sprawdzania poprawności wystąpienia analizy i zwracania go.

Parameters

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



Reset-Data-Analytic

URI: https://www.botlibre.com/rest/api/reset-data-analytic
Operation: POST
Type: XML
Interfejs API rest-data-analytic używany do odpoczynku danych wybranego analityka.

Parameters

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

Przykład

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



Test-Data-Analytic

URI: https://www.botlibre.com/rest/api/test-data-analytic
Operation: POST
Type: XML
Przetestuj dane analityczne za pomocą jednego zestawu danych wejściowych.

Parameters

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

Przykład

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


Przykładowe Wyniki

<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
Trenuj analitycznie dane za pomocą wielu zestawów wejść i wyjść.

Parameters

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

Przykład

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





Możesz wywołać dowolny z powyższych interfejsów API przy użyciu formatu JSON zamiast XML przy użyciu punktu końcowego /rest/json Zamiast /rest/api.



Cm. Również