Docs : Web API

Web API

また、埋め込むことができトークボットにお客様ご自身のウェブサイト、アクセス しかAndroidまたはiOSデバイスでもアクセストークボットを通じて、ボットのリブレをweb APIです。 のweb APIの利用を完全に制御ボットのクライアントインタフェース。

利用できるweb APIにアクセスボットからお客様ご自身のウェブサイトを通じてJavaScript、PHPその他言語です。 も利用できますのweb APIをモバイルにアクセスしてアプリケーショ御ボットなどのAndroidまたはiOS用します。

Web APIはHTTP GET/投稿URIのできる送受信メールデータをインポートします。 閲覧する際に、ウェブサイト、ブラウザはこのシリーズHTTP GET/POST要求Uriを返すのHTMLコンテンツです。 WebサービスのUriを返しXMLやJSONデータの代わりにHTMLコンテンツです。

ボットリブレ"のweb APIを提供三REST Apiです。 最初のセットのHTTP Uriを取得した形状データは、XMLデータを返します。 第二セットのAPIについてのHTTPポスト、XMLデータとXMLデータを返します。 第三セットのAPIについてのHTTPポストJSONデータを、JSONデータです。

ほとんどのアプリケーションを利用するXMLポストAPIでは、アプリケーションを選択フォームをご利用の取得APIめて簡単です。 のApiと同一の他そのメカニズムです。


チャットAPIのURL端

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のURL端

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.

ボットAPIのURL端

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

フォーラムAPIのURL端

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のURL端

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のURL端

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

ドメインのURL端

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

グラフィックURL端

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

分析 URL エンドポイント

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.

チャットAPIのURL端

Form Chat

URI: https://www.botlibre.biz/rest/api/form-chat
Operation: GET
Type: Form
の形成-チャットAPIを受けるチャットメッセージを返しますャボットの応答としてのXML文書です。

Parameters

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



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


例結果

<?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.biz/rest/api/chat
Operation: POST
Type: XML
チャットは、APIを受けるチャットメッセージを返しますャボットの応答としての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.



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


例結果

<?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.biz/rest/json/chat
Operation: POST
Type: JSON

Parameters

Parameter Required Type Description




ユーザにAPIのURL端

Form-Check-User

URI: https://www.botlibre.biz/rest/api/form-check-user
Operation: GET
Type: Form
フォームチェックユーザー API は、ユーザーを検証し、ユーザーの詳細を返します。

Parameters

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



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


例結果

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><user token="2635440427565872974" hint="hint" name="Test" email="test@email.com" over18="false"/>


Check-User

URI: https://www.botlibre.biz/rest/api/check-user
Operation: POST
Type: XML
ユーザーチェック API はユーザーを検証し、ユーザーの詳細を返します。

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.



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


例結果

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <user token="2635440427565872974" hint="hint" name="Test" email="test@email.com" over18="false"/>



ボットAPIのURL端

Get-Bots

URI: https://www.botlibre.biz/rest/api/get-bots
Operation: POST
Type: XML
すべてのアベイラベルボットを取得するために使用される get-bots API。

Parameters

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



Get-Bot-Script-Source

URI: https://www.botlibre.biz/rest/api/get-bot-script-source
Operation: POST
Type: XML
スクリプトのソースを取得するために使用される get-bot-script ソース API。

Parameters

Parameter Required Type Description



Delete-Bot

URI: https://www.botlibre.biz/rest/api/delete-bot
Operation: POST
Type: XML
削除ボット API は、選択したボットを削除します。

Parameters

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



Delete-Bot-Script

URI: https://www.botlibre.biz/rest/api/delete-bot-script
Operation: POST
Type: XML
ボットからスクリプトを削除するために使用される、削除ボット スクリプト API。

Parameters

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



Import-Bot-Script

URI: https://www.botlibre.biz/rest/api/import-bot-script
Operation: POST
Type: XML
スクリプトをボットにインポートするために使用されるインポートボットスクリプト API。

Parameters

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



Import-Bot-Log

URI: https://www.botlibre.biz/rest/api/import-bot-log
Operation: POST
Type: XML
ボットのログをインポートするために使用されるインポートボットログ API。

Parameters

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



Save-Bot-Avatar

URI: https://www.botlibre.biz/rest/api/save-bot-avatar
Operation: POST
Type: XML
アバターを選択してボット用に保存するために使用される、ボットの保存-アバター API。

Parameters

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



Save-Bot-Script-Source

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

Parameters

Parameter Required Type Description



Create-Bot-Attachment

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

Parameters

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



Up-Bot-Script

URI: https://www.botlibre.biz/rest/api/up-bot-script
Operation: POST
Type: XML
ボット スクリプトを上に移動するために使用するアップボット スクリプト API。

Parameters

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



Down-Bot-Script

URI: https://www.botlibre.biz/rest/api/down-bot-script
Operation: POST
Type: XML
ボット スクリプトの下に移動するために使用されるダウンボット スクリプト API。

Parameters

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



Get-Instances

URI: https://www.botlibre.biz/rest/api/get-instances
Operation: POST
Type: XML
get-instances API は、使用可能なすべてのインスタンスを取得します。

Parameters

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



Get-Instance-Users

URI: https://www.botlibre.biz/rest/api/get-instance-users
Operation: POST
Type: XML
get-instance-users API は、そのインスタンスのすべてのユーザーを取得します。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Instance id for validation.
user
attribute The ID of the user who is getting the users in from the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/get-instance-admins
Operation: POST
Type: XML
get-instance-admins API は、そのインスタンスのすべての管理者を取得します。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Instance id for validation.
user
attribute The ID of the user who is checking instance admins. The user must be registered with Bot Libre.
password
The password of the user.
token
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.biz/rest/api/get-all-instances
Operation: POST
Type: XML
フォーム取得のすべてのインスタンス API は、すべてのボット インスタンスの詳細を照会します。

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.



<browse application="1234567890"/>


例結果

<?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.biz/rest/api/check-instance
Operation: POST
Type: XML
チェックインスタンス API は、ボット ID または名前が存在することを検証し、ボットの詳細を返します。

Parameters

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



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


例結果

<?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.biz/rest/api/form-check-instance
Operation: GET
Type: Form
フォームチェックインスタンス API は、ボット ID または名前が存在することを検証し、ボットの詳細を返します。

Parameters

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



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


例結果

<?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.biz/rest/api/form-get-all-instances
Operation: GET
Type: Form
フォーム取得のすべてのインスタンス API は、すべてのボット インスタンスの詳細を照会します。

Parameters

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



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


例結果

<?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.biz/rest/api/update-instance
Operation: POST
Type: XML
更新インスタンス API により、選択したボットインスタンスのすべてのコンテンツをユーザーが更新できます。

Parameters

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



Update-Instance-Icon

URI: https://www.botlibre.biz/rest/api/update-instance-icon
Operation: POST
Type: XML
更新インスタンスアイコン API では、ユーザーがボットインスタンスのアイコンを変更できます。

Parameters

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



Create-Instance

URI: https://www.botlibre.biz/rest/api/create-instance
Operation: POST
Type: XML
新しいボット インスタンスを作成するための create-instance API。

Parameters

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



Edit-Instance

URI: https://www.botlibre.biz/rest/api/edit-instance
Operation: POST
Type: XML
ボット インスタンスを編集および更新する編集インスタンス API。

Parameters

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



Delete-Instance

URI: https://www.botlibre.biz/rest/api/delete-instance
Operation: POST
Type: XML
ボット インスタンスを削除するインスタンス削除 API。

Parameters

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



Flag-Instance

URI: https://www.botlibre.biz/rest/api/flag-instance
Operation: POST
Type: XML
フラグインスタンス API は、ボットインスタンスをフラグします。

Parameters

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



Star-Instance

URI: https://www.botlibre.biz/rest/api/star-instance
Operation: POST
Type: XML
スターインスタンス API は、ボットインスタンスを示します。

Parameters

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



Train-Instance

URI: https://www.botlibre.biz/rest/api/train-instance
Operation: POST
Type: XML
トレーニング インスタンス API は、チャット ボット インスタンスをトレーニングします。

Parameters

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



Thumbs-Up-Instance

URI: https://www.botlibre.biz/rest/api/thumbs-up-instance
Operation: POST
Type: XML
ユーザーは、チャット ボット インスタンスに親指を配置できます。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Instance id for validation.
user
attribute The ID of the user who is placing a thumbs up on the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/thumbs-down-instance
Operation: POST
Type: XML
ユーザーがチャットボットインスタンスに親指を置くことができるサムダウンインスタンス

Parameters

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




フォーラムAPIのURL端

Get-Forums

URI: https://www.botlibre.biz/rest/api/get-forums
Operation: POST
Type: XML
利用可能なフォーラムを取得するために使用される get-フォーラム API。

Parameters

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



Get-Forum-Posts

URI: https://www.botlibre.biz/rest/api/get-forum-posts
Operation: POST
Type: XML
各フォーラムの利用可能な投稿を取得するために使用される get-フォーラム投稿 API。

Parameters

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



Get-Forum-Users

URI: https://www.botlibre.biz/rest/api/get-forum-users
Operation: POST
Type: XML
各フォーラムのユーザーを取得するために使用される get-forum-users API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Forum id for validation.
user
attribute The ID of the user who is getting the users in the forum. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/get-forum-admins
Operation: POST
Type: XML
各フォーラムの管理者を取得するために使用される get-forum-admins API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Forum id for validation.
user
attribute The ID of the user who is checking forum admins. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/save-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Create-Forum

URI: https://www.botlibre.biz/rest/api/create-forum
Operation: POST
Type: XML
新しいフォーラムを作成するためのフォーラム作成 API。

Parameters

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



Create-Forum-Attachment

URI: https://www.botlibre.biz/rest/api/create-forum-attachment
Operation: POST
Type: XML
添付ファイルを含むフォーラムを作成するためのフォーラム添付ファイルの作成 API。

Parameters

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



Create-Forum-Post

URI: https://www.botlibre.biz/rest/api/create-forum-post
Operation: POST
Type: XML
フォーラムの新しい投稿を作成するための作成フォーラム投稿 API。

Parameters

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



Update-Forum

URI: https://www.botlibre.biz/rest/api/update-forum
Operation: POST
Type: XML
フォーラムの内容を更新するために使用される更新フォーラム API。

Parameters

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



Update-Forum-Post

URI: https://www.botlibre.biz/rest/api/update-forum-post
Operation: POST
Type: XML
更新フォーラム投稿 API は、フォーラムの投稿の内容を更新します。

Parameters

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



Update-Forum-Icon

URI: https://www.botlibre.biz/rest/api/update-forum-icon
Operation: POST
Type: XML
4mのアイコンを変更するために使用される更新フォーラムアイコンAPI。

Parameters

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



Check-Forum

URI: https://www.botlibre.biz/rest/api/check-forum
Operation: POST
Type: XML
チェックフォーラム API は、フォーラムを検証して返します。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/check-forum-post
Operation: POST
Type: XML
チェックフォーラムポストAPIは、フォーラムの投稿をチェックして検証し、フォーラムの投稿を返します。

Parameters

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



Delete-Forum

URI: https://www.botlibre.biz/rest/api/delete-forum
Operation: POST
Type: XML
フォーラムを削除する削除フォーラム API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/delete-forum-post
Operation: POST
Type: XML
削除フォーラム投稿 API 削除は、フォーラムの投稿です。

Parameters

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



Flag-Forum

URI: https://www.botlibre.biz/rest/api/flag-forum
Operation: POST
Type: XML
フォーラムにフラグを設定するために使用されるフラグフォーラム API。

Parameters

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



Flag-Forum-Post

URI: https://www.botlibre.biz/rest/api/flag-forum-post
Operation: POST
Type: XML
フラグフォーラムポスト API フラグはフォーラムの投稿です。

Parameters

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



Thumbs-Up-Forum

URI: https://www.botlibre.biz/rest/api/thumbs-up-forum
Operation: POST
Type: XML
つまみアップフォーラム API は、フォーラムに親指を配置するために使用されます。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Forum id for validation.
user
attribute The ID of the user who is placing a thumbs up to a forum. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/thumbs-down-forum
Operation: POST
Type: XML
つまみ下りのフォーラム API は、つまみからフォーラムに配置するために使用されます。

Parameters

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



Subscribe-Forum

URI: https://www.botlibre.biz/rest/api/subscribe-forum
Operation: POST
Type: XML
サブスクライブ フォーラム API は、ユーザーがフォーラムを購読できるようにする API です。

Parameters

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



Unsubscribe-Forum

URI: https://www.botlibre.biz/rest/api/unsubscribe-forum
Operation: POST
Type: XML
登録解除フォーラム API は、ユーザーがフォーラムの登録を解除できるようにする API です。

Parameters

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



Star-Forum

URI: https://www.botlibre.biz/rest/api/star-forum
Operation: POST
Type: XML
スターフォーラム API は、ユーザーがフォーラムにスターを配置できるようにするものです。

Parameters

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




スクリプトAPIのURL端

Get-Forums

URI: https://www.botlibre.biz/rest/api/get-forums
Operation: POST
Type: XML
利用可能なフォーラムを取得するために使用される get-フォーラム API。

Parameters

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



Get-Forum-Posts

URI: https://www.botlibre.biz/rest/api/get-forum-posts
Operation: POST
Type: XML
各フォーラムの利用可能な投稿を取得するために使用される get-フォーラム投稿 API。

Parameters

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



Get-Forum-Users

URI: https://www.botlibre.biz/rest/api/get-forum-users
Operation: POST
Type: XML
各フォーラムのユーザーを取得するために使用される get-forum-users API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Forum id for validation.
user
attribute The ID of the user who is getting the users in the forum. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/get-forum-admins
Operation: POST
Type: XML
get-forum-admins API は、フォーラムのすべての管理者を取得することです。

Parameters

Parameter Required Type Description
application
Your application ID.
id
forum id for validation.
user
attribute The ID of the user who is checking forum admins. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/save-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter Required Type Description



Get-Forum-Bot-Mode

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

Parameters

Parameter Required Type Description



Create-Forum

URI: https://www.botlibre.biz/rest/api/create-forum
Operation: POST
Type: XML
フォーラム作成 API は、新しいフォーラムを作成するために使用されます。

Parameters

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



Create-Forum-Attachment

URI: https://www.botlibre.biz/rest/api/create-forum-attachment
Operation: POST
Type: XML
添付ファイルを含むフォーラムを作成するためのフォーラム添付ファイルの作成 API。

Parameters

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



Create-Forum-Post

URI: https://www.botlibre.biz/rest/api/create-forum-post
Operation: POST
Type: XML
フォーラムの新しい投稿を作成するための作成フォーラム投稿 API。

Parameters

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



Update-Forum

URI: https://www.botlibre.biz/rest/api/update-forum
Operation: POST
Type: XML
フォーラムの内容を更新するために使用される更新フォーラム API。

Parameters

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



Update-Forum-Post

URI: https://www.botlibre.biz/rest/api/update-forum-post
Operation: POST
Type: XML
更新フォーラム投稿 API は、フォーラムの投稿の内容を更新します。

Parameters

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



Update-Forum-Icon

URI: https://www.botlibre.biz/rest/api/update-forum-icon
Operation: POST
Type: XML
4mのアイコンを変更するために使用される更新フォーラムアイコンAPI。

Parameters

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



Check-Forum

URI: https://www.botlibre.biz/rest/api/check-forum
Operation: POST
Type: XML
チェックフォーラム API は、フォーラムを検証して返します。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/check-forum-post
Operation: POST
Type: XML
チェックフォーラムポストAPIは、フォーラムの投稿をチェックして検証し、フォーラムの投稿を返します。

Parameters

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



Delete-Forum

URI: https://www.botlibre.biz/rest/api/delete-forum
Operation: POST
Type: XML
フォーラムを削除する削除フォーラム API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Forum id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/delete-forum-post
Operation: POST
Type: XML
削除フォーラム投稿 API 削除は、フォーラムの投稿です。

Parameters

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



Flag-Forum

URI: https://www.botlibre.biz/rest/api/flag-forum
Operation: POST
Type: XML
フォーラムにフラグを設定するために使用されるフラグフォーラム API。

Parameters

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



Flag-Forum-Post

URI: https://www.botlibre.biz/rest/api/flag-forum-post
Operation: POST
Type: XML
フラグフォーラムポスト API フラグはフォーラムの投稿です。

Parameters

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



Thumbs-Up-Forum

URI: https://www.botlibre.biz/rest/api/thumbs-up-forum
Operation: POST
Type: XML
つまみアップフォーラム API は、フォーラムに親指を配置するために使用されます。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Forum id for validation.
user
attribute The ID of the user who is placing a thumbs up to a forum. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/thumbs-down-forum
Operation: POST
Type: XML
つまみ下りのフォーラム API は、つまみからフォーラムに配置するために使用されます。

Parameters

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



Subscribe-Forum

URI: https://www.botlibre.biz/rest/api/subscribe-forum
Operation: POST
Type: XML
サブスクライブ フォーラム API は、ユーザーがフォーラムを購読できるようにする API です。

Parameters

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



Unsubscribe-Forum

URI: https://www.botlibre.biz/rest/api/unsubscribe-forum
Operation: POST
Type: XML
登録解除フォーラム API は、ユーザーがフォーラムの登録を解除できるようにする API です。

Parameters

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



Star-Forum

URI: https://www.botlibre.biz/rest/api/star-forum
Operation: POST
Type: XML
スターフォーラム API は、ユーザーがフォーラムにスターを配置できるようにするものです。

Parameters

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




アバターのAPIのURL端

Get-Avatars

URI: https://www.botlibre.biz/rest/api/get-avatars
Operation: POST
Type: XML
入手アバター API は、利用可能なアバターを取得するために使用されます。

Parameters

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



Get-Avatar-Users

URI: https://www.botlibre.biz/rest/api/get-avatar-users
Operation: POST
Type: XML
そのアバターに関連するすべてのユーザーを取得するために使用される get-avatars-users API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
avatars id for validation.
user
attribute The ID of the user who is getting the users in the avatar. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/get-avatar-admins
Operation: POST
Type: XML
選択したアバターのすべての管理者を取得するために使用される get-avatar-admins API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
avatar id for validation.
user
attribute The ID of the user who is checking avatar admins. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/get-avatar-media
Operation: POST
Type: XML
アバターのメディアを取得するために使用される、取得アバターメディア API。

Parameters

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



Create-Avatar

URI: https://www.botlibre.biz/rest/api/create-avatar
Operation: POST
Type: XML
新しいアバターを作成するために使用するアバター作成 API。

Parameters

Parameter Required Type Description
application
Your application ID.
user
attribute The ID of the user who is creating the avatar. The user must be registered with Bot Libre.
password
attribute The password of the user who is creating the avatar.
token
The token of the user. A token can be obtained through check-user, and is valid until reset.
name
attribute The avatar name that used to identify the avatar.
alias
attribute Another name can be used for the new avatar to be identified.
description
attribute Brief description for the avatar.
details
attribute Details for the avatar.
disclaimer
attribute Disclaimer regarding the new avatar.
license
attribute License to release the avatar and all its content under.
website
attribute URL for the avatar if it has it's own website.
categories
attribute 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
private
Avatar can be private, and accessed only by the user.
hidden
Hidden avatar will not be available to public.
access-mode
Avatar will be accessed by based on the following options (Everyone, Users, Members, Admin).
fork-access-mode
Avatar will be able to copy by based on the following options (Everyone, Users, Members, Admin).
content-rating
Avatar can be viewed or rated for (Everyone, Teen, Mature).



Create-Avatar-Media

URI: https://www.botlibre.biz/rest/api/create-avatar-media
Operation: POST
Type: XML
アバター用のメディアを作成するために使用する作成アバターメディア API。

Parameters

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



Save-Avatar-Media

URI: https://www.botlibre.biz/rest/api/save-avatar-media
Operation: POST
Type: XML
アバターの現在のメディアの変更を保存するために使用される保存アバターメディア API。

Parameters

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



Save-Avatar-Background

URI: https://www.botlibre.biz/rest/api/save-avatar-background
Operation: POST
Type: XML
保存アバター背景 API は、アバターの背景画像を保存します。

Parameters

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



Save-Bot-Avatar

URI: https://www.botlibre.biz/rest/api/save-bot-avatar
Operation: POST
Type: XML
アバターを選択してボット用に保存するために使用される、ボットの保存-アバター API。

Parameters

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



Delete-Avatar

URI: https://www.botlibre.biz/rest/api/delete-avatar
Operation: POST
Type: XML
選択したアバターを削除するために使用する削除アバター API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/delete-avatar-media
Operation: POST
Type: XML
アバターのメディアを削除するために使用される、アバターの削除メディア API。

Parameters

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



Delete-Avatar-Background

URI: https://www.botlibre.biz/rest/api/delete-avatar-background
Operation: POST
Type: XML
アバターの背景画像を削除するために使用される、アバターの背景を削除する API。

Parameters

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



Check-Avatar

URI: https://www.botlibre.biz/rest/api/check-avatar
Operation: POST
Type: XML
チェックアバター API は、アバターを検証して返すために使用されます。

Parameters

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



Avatar-Message

URI: https://www.botlibre.biz/rest/api/avatar-message
Operation: POST
Type: XML
アバターメッセージ API

Parameters

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



Star-Avatar

URI: https://www.botlibre.biz/rest/api/star-avatar
Operation: POST
Type: XML
ユーザーがアバターをスター表示するために使用するスターアバター API。

Parameters

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



Flag-Avatar

URI: https://www.botlibre.biz/rest/api/flag-avatar
Operation: POST
Type: XML
アバターにフラグを設定するために使用されるフラグアバター API。

Parameters

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



Init-Avatar

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

Parameters

Parameter Required Type Description



Update-Avatar

URI: https://www.botlibre.biz/rest/api/update-avatar
Operation: POST
Type: XML
アバターのコンテンツを更新および変更するために使用される更新アバター API。

Parameters

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



Update-Avatar-Icon

URI: https://www.botlibre.biz/rest/api/update-avatar-icon
Operation: POST
Type: XML
アバターのアイコンを更新するために使用される更新アバターアイコン API

Parameters

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



Thumbs-Up-Avatar

URI: https://www.botlibre.biz/rest/api/thumbs-up-avatar
Operation: POST
Type: XML
選択したアバターに親指を置くために使用されるサムアップアバター API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Avatar id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/thumbs-down-avatar
Operation: POST
Type: XML
選択したアバターに親指を置くために使用されるサムダウンアバター API。

Parameters

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




ドメインのURL端

Get-Domains

URI: https://www.botlibre.biz/rest/api/get-domains
Operation: POST
Type: XML
使用可能なすべてのドメインを取得するために使用される get ドメイン API。

Parameters

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



Get-Domain-Users

URI: https://www.botlibre.biz/rest/api/get-domain-users
Operation: POST
Type: XML
ドメインのすべてのユーザーを取得するために使用される get-domain-users API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Domain id for validation.
user
attribute The ID of the user who is getting the users in the domain. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/get-domain-admins
Operation: POST
Type: XML
ドメインのすべての管理者を取得するために使用される get-domain-admins API。

Parameters

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



Get-Domain

URI: https://www.botlibre.biz/rest/api/get-domain
Operation: POST
Type: XML
get-domain API は、選択したドメインを取得します。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Domain id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/get-domain-icon
Operation: POST
Type: XML
ドメインのアイコンを返すために使用される get ドメイン アイコン API。

Parameters

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



Create-Domain

URI: https://www.botlibre.biz/rest/api/create-domain
Operation: POST
Type: XML
ドメイン作成 API は新しいドメインを作成します。

Parameters

Parameter Required Type Description
application
Your application ID.
user
attribute The ID of the user who is creating the domain. The user must be registered with Bot Libre.
template
Type of bot to create.
password
attribute The password of the user who is creating the domain.
token
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
attribute Brief description for the domain.
details
attribute Details for the domain.
disclaimer
attribute Disclaimer regarding the new domain.
license
attribute License to release the domain and all its content under.
website
attribute URL for the domain if it has it's own website.
website-subdomain
You can choose a subdomain to host your forum's own website, or give a domain that you have registered and forward to this server's ip address.
categories
attribute On what category would you place your domain. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags
attribute Tags for your domain
private
Instance can be private, and accessed only by the user.
hidden
Hidden domain will not be available to public.
access-mode
Domain will be accessed by based on the following options (Everyone, Users, Members, Admin).
fork-access-mode
Domain will be able to copy by based on the following options (Everyone, Users, Members, Admin).
content-rating
Domain can be viewed or rated for (Everyone, Teen, Mature).
creation-mode
Who can create channels, forums, bots in this domain.



Check-Domain

URI: https://www.botlibre.biz/rest/api/check-domain
Operation: POST
Type: XML
ドメインを検証して戻すために使用されるチェックドメイン API。

Parameters

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



Update-Domain

URI: https://www.botlibre.biz/rest/api/update-domain
Operation: POST
Type: XML
ドメイン更新 API は、ドメインの内容を更新します。

Parameters

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



Delete-Domain

URI: https://www.botlibre.biz/rest/api/delete-domain
Operation: POST
Type: XML
ドメイン削除 API は、選択したドメインを削除します。

Parameters

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



Flag-Domain

URI: https://www.botlibre.biz/rest/api/flag-domain
Operation: POST
Type: XML
ドメインにフラグを設定するために使用される falg ドメイン API。

Parameters

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



Star-Domain

URI: https://www.botlibre.biz/rest/api/star-domain
Operation: POST
Type: XML
スタードメイン API は、ドメインにスターを配置するために使用されます。

Parameters

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



Thumbs-Up-Domain

URI: https://www.botlibre.biz/rest/api/thumbs-up-domain
Operation: POST
Type: XML
ドメインをサムアップするために使用されるサムアップドメイン API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Domain id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/thumbs-down-domain
Operation: POST
Type: XML
選択したドメインに対してサムダウン ドメイン API を使用します。

Parameters

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




グラフィックURL端

Get-Graphics

URI: https://www.botlibre.biz/rest/api/get-graphics
Operation: POST
Type: XML
get-graphics API は、使用可能なすべてのグラフィックスを取得します。

Parameters

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



Get-Graphic-Users

URI: https://www.botlibre.biz/rest/api/get-graphic-users
Operation: POST
Type: XML
get-graphic-users API は、選択したグラフィックのすべてのユーザーを返します。

Parameters

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



Get-Graphic-Admins

URI: https://www.botlibre.biz/rest/api/get-graphic-admins
Operation: POST
Type: XML
get-graphic-admins API は、選択したグラフィックのすべての管理者を返します。

Parameters

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



Update-Graphic

URI: https://www.botlibre.biz/rest/api/update-graphic
Operation: POST
Type: XML
グラフィックの内容を更新するために使用される更新グラフィック API。

Parameters

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



Update-Graphic-Icon

URI: https://www.botlibre.biz/rest/api/update-graphic-icon
Operation: POST
Type: XML
グラフィック アイコンの変更と更新に使用される更新グラフィック アイコン API。

Parameters

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



Update-Graphic-Media

URI: https://www.botlibre.biz/rest/api/update-graphic-media
Operation: POST
Type: XML
選択したグラフィックのメディア コンテンツを更新するために使用される更新グラフィック メディア API。

Parameters

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



Create-Graphic

URI: https://www.botlibre.biz/rest/api/create-graphic
Operation: POST
Type: XML
新しいグラフィックを作成するために使用されるグラフィック作成 API。

Parameters

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



Delete-Graphic

URI: https://www.botlibre.biz/rest/api/delete-graphic
Operation: POST
Type: XML
選択したグラフィックを削除するために使用される削除グラフィック API。

Parameters

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



Check-Graphic

URI: https://www.botlibre.biz/rest/api/check-graphic
Operation: POST
Type: XML
グラフィックを検証して返すために使用されるチェック グラフィック API。

Parameters

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



Flag-Graphic

URI: https://www.botlibre.biz/rest/api/flag-graphic
Operation: POST
Type: XML
グラフィックにフラグを設定するために使用されるフラググラフィック API。

Parameters

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



Star-Graphic

URI: https://www.botlibre.biz/rest/api/star-graphic
Operation: POST
Type: XML
星をグラフィックに配置するために使用される星図 API。

Parameters

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



Thumbs-Up-Graphic

URI: https://www.botlibre.biz/rest/api/thumbs-up-graphic
Operation: POST
Type: XML
選択したグラフィックに親指を配置するために使用されるサムアップグラフィック API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Graphic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/thumbs-down-graphic
Operation: POST
Type: XML
選択したグラフィックに親指を配置するために使用されるサム ダウン グラフィック API。

Parameters

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




分析 URL エンドポイント

Get-Analytics

URI: https://www.botlibre.biz/rest/api/get-analytics
Operation: POST
Type: XML
すべての利用できる分析を取得するために使用される get-analytics API。

Parameters

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



Get-Analytic-Users

URI: https://www.botlibre.biz/rest/api/get-analytic-users
Operation: POST
Type: XML
分析のすべてのユーザーを取得するために使用される get-分析ユーザー API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
analytic id for validation.
user
attribute The ID of the user who is getting the users in the analytic. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/get-analytic-admins
Operation: POST
Type: XML
選択した分析のすべての管理者を取得するために使用される get-分析システム API。

Parameters

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



Test-Analytic

URI: https://www.botlibre.biz/rest/api/test-analytic
Operation: POST
Type: XML
特定の手順でトレーニングされた分析モデルをテストするために使用されるテスト分析 API。

Parameters

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



Test-Audio-Analytic

URI: https://www.botlibre.biz/rest/api/test-audio-analytic
Operation: POST
Type: XML
オーディオ モデルの分析をテストするために使用されるテストオーディオ分析 API。

Parameters

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



Test-Object-Detection-Analytic

URI: https://www.botlibre.biz/rest/api/test-object-detection-analytic
Operation: POST
Type: XML
特定の命令を使用してオブジェクト検出分析モデルをテストするために使用される、オブジェクト検出分析 API。

Parameters

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



Get-Test-Media-Result

URI: https://www.botlibre.biz/rest/api/get-test-media-result
Operation: POST
Type: XML
get-test-media-result API は、テスト メディアの結果を取得します。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/report-media-analytic
Operation: POST
Type: XML
分析レポトを取得するために使用されるレポート メディア分析 API。

Parameters

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



Train-Analytic

URI: https://www.botlibre.biz/rest/api/train-analytic
Operation: POST
Type: XML
分析モデルをトレーニングするために使用される列車分析 API。

Parameters

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



Delete-Analytic-Media

URI: https://www.botlibre.biz/rest/api/delete-analytic-media
Operation: POST
Type: XML
選択した分析メディアを削除するために使用される削除分析メディア API。

Parameters

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



Delete-Analytic-Test-Media

URI: https://www.botlibre.biz/rest/api/delete-analytic-test-media
Operation: POST
Type: XML
分析のテスト メディアを削除するために使用する、分析テスト メディアの削除 API。

Parameters

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



Get-Analytic-Media

URI: https://www.botlibre.biz/rest/api/get-analytic-media
Operation: POST
Type: XML
すべての分析メディアを取得するために使用される get-分析メディア API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/get-analytic-test-media
Operation: POST
Type: XML
get-分析テストメディア API は、分析のテストメディアを取得します。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/create-analytic-label
Operation: POST
Type: XML
分析用のラベルを作成します。各ラベルは分類子です。各ラベルは、パッケージに一連の画像が含まれるようなものです。これは、画像認識のトレーニングフェーズを開始する前に必要です。各分析には、少なくとも 2 つのラベルが必要です。

Parameters

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



Create-Analytic-Test-Media-Label

URI: https://www.botlibre.biz/rest/api/create-analytic-test-media-label
Operation: POST
Type: XML
分析用のラベルを作成します。各ラベルは分類子です。各ラベルは、パッケージに一連の画像が含まれるようなものです。これは、画像認識のトレーニングフェーズを開始する前に必要です。各分析には、少なくとも 2 つのラベルが必要です。

Parameters

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



Delete-Analytic-Label

URI: https://www.botlibre.biz/rest/api/delete-analytic-label
Operation: POST
Type: XML
分析オブジェクトの選択したラベルを削除するために使用される削除分析ラベル API。

Parameters

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



Delete-Analytic-Test-Media-Label

URI: https://www.botlibre.biz/rest/api/delete-analytic-test-media-label
Operation: POST
Type: XML
分析のテスト メディア ラベルを削除するために使用する削除分析テスト メディア ラベル API。

Parameters

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



Check-Training

URI: https://www.botlibre.biz/rest/api/check-training
Operation: POST
Type: XML
モデルの現在のトレーニングの情報を取得するために使用されるチェック トレーニング API。

Parameters

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



Create-Analytic

URI: https://www.botlibre.biz/rest/api/create-analytic
Operation: POST
Type: XML
作成分析 API は、新しい分析を作成します。

Parameters

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



Update-Analytic

URI: https://www.botlibre.biz/rest/api/update-analytic
Operation: POST
Type: XML
更新分析 API の更新または選択した分析の詳細の変更。

Parameters

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



Flag-Analytic

URI: https://www.botlibre.biz/rest/api/flag-analytic
Operation: POST
Type: XML
分析にフラグを配置するために使用されるフラグ分析 API。

Parameters

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



Thumbs-Up-Analytic

URI: https://www.botlibre.biz/rest/api/thumbs-up-analytic
Operation: POST
Type: XML
分析薬をつまみ上げるために使用される親指アップ分析 API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
分析に足を引くために使用されるサムダウン分析 API。

Parameters

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



Star-Analytic

URI: https://www.botlibre.biz/rest/api/star-analytic
Operation: POST
Type: XML
星分析 API は、分析オブジェクトを示すために使用されます。

Parameters

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



Delete-Analytic

URI: https://www.botlibre.biz/rest/api/delete-analytic
Operation: POST
Type: XML
選択した分析を削除するために使用される削除分析 API。

Parameters

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



Check-Analytic

URI: https://www.botlibre.biz/rest/api/check-analytic
Operation: POST
Type: XML
分析のインスタンスを検証し、それを返すために使用されるチェック分析 API。

Parameters

Parameter Required Type Description
application
Your application ID.
id
Analytic id for validation.
user
attribute The ID of the user who is flag the instance. The user must be registered with Bot Libre.
password
The password of the user
token
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.biz/rest/api/reset-data-analytic
Operation: POST
Type: XML
選択した分析のデータを残すために使用される残りのデータ分析 API。

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.



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



Test-Data-Analytic

URI: https://www.botlibre.biz/rest/api/test-data-analytic
Operation: POST
Type: XML
1 組の入力でデータ分析をテストします。

Parameters

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



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


例結果

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


Train-Data-Analytic

URI: https://www.botlibre.biz/rest/api/train-data-analytic
Operation: POST
Type: XML
複数の入力と出力のセットを使用してデータ分析をトレーニングします。

Parameters

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



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





エンドポイントを使用して、XML の代わりに JSON を使用して上記の API のいずれかを呼び出すことができます。 /rest/json 代わりに /rest/api.



参照