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

ライブチャット API URL エンドポイント

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

フォーラム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-scripts	POST	XML	Retrieve the scripts.
/rest/api/get-script-users	POST	XML	Get users of a script.
/rest/api/get-script-admins	POST	XML	Get admins of a script.
/rest/api/create-script	POST	XML	Create a new script.
/rest/api/update-script	POST	XML	Update the contents of the script.
/rest/api/update-script-icon	POST	XML	Update the icon of the script.
/rest/api/check-script	POST	XML	Check to validate and returns a script.
/rest/api/delete-script	POST	XML	Delete a script.
/rest/api/flag-script	POST	XML	Flag a script.
/rest/api/thumbs-up-script	POST	XML	Placing a thumbs up to a script.
/rest/api/thumbs-down-script	POST	XML	Placing a thumbs down to a script.
/rest/api/star-script	POST	XML	Placing a star to a script.

アバターの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/delete-avatar	POST	XML	Delete an avatar.
/rest/api/delete-avatar-media	POST	XML	Delete a media of an avatar.
/rest/api/delete-avatar-background	POST	XML	Delete a background image of an avatar.
/rest/api/check-avatar	POST	XML	Validate an avatar and return it back to the user.
/rest/api/avatar-message	POST	XML	Avatar Message.
/rest/api/star-avatar	POST	XML	Placing a star to an avatar.
/rest/api/flag-avatar	POST	XML	Flag an avatar.
/rest/api/init-avatar	POST	XML
/rest/api/update-avatar	POST	XML	Update the contents of an avatar.
/rest/api/update-avatar-icon	POST	XML	Update the avatar icon.
/rest/api/thumbs-up-avatar	POST	XML	Placing a thumbs up to an avatar.
/rest/api/thumbs-down-avatar	POST	XML	Placing a thumbs down to an avatar.

ドメインのURL端

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.com/rest/api/form-chat
Operation: GET
Type: Form
の形成-チャットAPIを受けるチャットメッセージを返しますャボットの応答としてのXML文書です。

Parameters

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

例

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

Parameters

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

例

例結果

JSON Chat

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

Parameters

Parameter	Required	Type	Description

ユーザにAPIのURL端

Form-Check-User

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

Parameters

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

例

https://www.botlibre.com/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="[email protected]" over18="false"/>

Check-User

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

Parameters

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

例

例結果

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

ボットAPIのURL端

Get-Bots

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

Parameters

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

Get-Bot-Script-Source

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

Parameters

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

Delete-Bot-Script

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

Parameters

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

Import-Bot-Script

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

Parameters

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

Import-Bot-Log

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

Parameters

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

Save-Bot-Avatar

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

Parameters

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

Save-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/save-bot-script-source
Operation: POST
Type: XML
スクリプトを選択し、ボット用に保存するために使用される保存ボットスクリプトソース API。

Parameters

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

Create-Bot-Attachment

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

Parameters

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

Up-Bot-Script

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

Parameters

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

Down-Bot-Script

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

Parameters

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

Get-Instances

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

Parameters

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

Get-Instance-Users

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

Parameters

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

Get-Instance-Admins

URI: https://www.botlibre.com/rest/api/get-instance-admins
Operation: POST
Type: XML
get-instance-admins API は、そのボットインスタンスのすべての管理者を取得します。

Parameters

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

Get-All-Instances

URI: https://www.botlibre.com/rest/api/get-all-instances
Operation: POST
Type: XML
フォーム取得のすべてのインスタンス API は、すべてのボットインスタンスの詳細を照会します。

Parameters

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

例

例結果

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

Check-Instance

URI: https://www.botlibre.com/rest/api/check-instance
Operation: POST
Type: XML
チェックインスタンス API は、ボット ID または名前が存在することを検証し、ボットの詳細を返します。

Parameters

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

例

例結果

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

Form-Check-Instance

URI: https://www.botlibre.com/rest/api/form-check-instance
Operation: GET
Type: Form
フォームチェックインスタンス API は、ボット ID または名前が存在することを検証し、ボットの詳細を返します。

Parameters

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

例

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

例結果

Form-Get-All-Instances

URI: https://www.botlibre.com/rest/api/form-get-all-instances
Operation: GET
Type: Form
フォーム取得のすべてのインスタンス API は、すべてのボットインスタンスの詳細を照会します。

Parameters

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

例

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

Parameters

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

Update-Instance-Icon

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

Parameters

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

Create-Instance

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

Parameters

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

Delete-Instance

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

Parameters

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

Flag-Instance

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

Parameters

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

Star-Instance

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

Parameters

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

Train-Instance

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

Parameters

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

Thumbs-Up-Instance

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

Parameters

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

Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-instance
Operation: POST
Type: XML
ユーザーがチャットボットインスタンスに親指を置くことができるサムダウンインスタンス

Parameters

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

ライブチャット API URL エンドポイント

Get-Channel-Bot-Mode

URI: https://www.botlibre.com/rest/api/get-channel-bot-mode
Operation: POST
Type: XML
取得チャネルボットモードAPIは、チャネルボットモードを取得しました。

Parameters

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

Save Channel Bot Mode

URI: https://www.botlibre.com/rest/api/save-channel-bot-mode
Operation: POST
Type: XML
チャネルボットモードの保存に使用される保存チャネルボットモード API。

Parameters

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

Create channel attachment

URI: https://www.botlibre.com/rest/api/create-channel-attachment
Operation: POST
Type: XML
チャネルの添付ファイルを作成するために使用されるチャネル添付ファイル作成 API は、チャネルの添付ファイルを作成します。

Parameters

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

Create Channel

URI: https://www.botlibre.com/rest/api/create-channel
Operation: POST
Type: XML
新しいチャネルの作成に使用されるチャネル作成 API。

Parameters

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

Create Channel

URI: https://www.botlibre.com/rest/api/update-channel
Operation: POST
Type: XML
既存のチャネルを更新するために使用される更新チャネル API。

Parameters

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

Get bot channel

URI: https://www.botlibre.com/rest/api/get-bot-channel
Operation: POST
Type: XML
ボットのチャネルを取得するために使用される get-bot-channel API。

Parameters

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

Get user channel

URI: https://www.botlibre.com/rest/api/get-user-channel
Operation: POST
Type: XML
ユーザーチャネルを取得するために使用されるユーザーチャネル取得 API。

Parameters

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

Get Channels

URI: https://www.botlibre.com/rest/api/get-channels
Operation: POST
Type: XML
使用可能なすべてのチャネルを取得するために使用されるチャネル取得 API。

Parameters

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

Get channel users

URI: https://www.botlibre.com/rest/api/get-channel-users
Operation: POST
Type: XML
選択したチャネルのすべてのユーザーを返すために使用されるチャネルユーザー API です。

Parameters

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

Get Channel Admins

URI: https://www.botlibre.com/rest/api/get-channel-admins
Operation: POST
Type: XML
選択したチャネルのすべての管理者を返すために使用される get-channel-admins API です。

Parameters

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

Update Channel Icon

URI: https://www.botlibre.com/rest/api/update-channel-icon
Operation: POST
Type: XML
チャネルのアイコンを更新するために使用されるチャネルアイコンの更新 API。

Parameters

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

Thumbs Up Channel

URI: https://www.botlibre.com/rest/api/thumbs-up-channel
Operation: POST
Type: XML
ユーザーが親指をチャネルに配置できるようにするために使用されるサムズアップチャネル API。

Parameters

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

Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-channel
Operation: POST
Type: XML
ユーザーが親指をチャネルに下げるために使用されるサムズアップチャネル API。

Parameters

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

Flag-Channel

URI: https://www.botlibre.com/rest/api/flag-channel
Operation: POST
Type: XML
チャネルにフラグを立てるために使用されるフラグ・チャネル API。

Parameters

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

Star-Channel

URI: https://www.botlibre.com/rest/api/star-channel
Operation: POST
Type: XML
チャンネルをスターにするために使用されるスターチャネル API。

Parameters

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

Delete-Channel

URI: https://www.botlibre.com/rest/api/delete-channel
Operation: POST
Type: XML
チャネルの削除に使用されるチャネル削除 API。

Parameters

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

Check-Channel

URI: https://www.botlibre.com/rest/api/check-channel
Operation: POST
Type: XML
チャネルの検証と返却に使用されるチャネルチェック API。

Parameters

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

フォーラムAPIのURL端

Get-Forums

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

Parameters

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

Get-Forum-Posts

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

Parameters

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

Get-Forum-Users

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

Parameters

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

Get-Forum-Admins

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

Parameters

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

Save-Forum-Bot-Mode

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

Parameters

Parameter	Required	Type	Description

Get-Forum-Bot-Mode

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

Parameters

Parameter	Required	Type	Description

Create-Forum

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

Parameters

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

Create-Forum-Attachment

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

Parameters

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

Create-Forum-Post

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

Parameters

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

Update-Forum

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

Parameters

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

Update-Forum-Post

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

Parameters

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

Update-Forum-Icon

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

Parameters

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

Check-Forum

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

Parameters

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

Check-Forum-Post

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

Parameters

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

Delete-Forum

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

Parameters

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

Delete-Forum-Post

URI: https://www.botlibre.com/rest/api/delete-forum-post
Operation: POST
Type: XML
削除フォーラム投稿 API 削除は、フォーラムの投稿です。

Parameters

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

Flag-Forum

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

Parameters

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

Flag-Forum-Post

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

Parameters

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

Thumbs-Up-Forum

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

Parameters

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

Thumbs-Down-Forum

URI: https://www.botlibre.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
つまみ下りのフォーラム API は、つまみからフォーラムに配置するために使用されます。

Parameters

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

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

Parameters

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

Unsubscribe-Forum

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

Parameters

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

Star-Forum

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

Parameters

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

スクリプトAPIのURL端

Get-Scripts

URI: https://www.botlibre.com/rest/api/get-scripts
Operation: POST
Type: XML
使用可能なスクリプトを取得するために使用される get-scripts API。

Parameters

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

Get-Script-Users

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

Parameters

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

Get-Script-Admins

URI: https://www.botlibre.com/rest/api/get-script-admins
Operation: POST
Type: XML
get-script-admins API は、スクリプトのすべての管理者を取得するためのものです。

Parameters

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

Create-Script

URI: https://www.botlibre.com/rest/api/create-script
Operation: POST
Type: XML
スクリプト作成 API は、新しいスクリプトを作成するために使用されます。

Parameters

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

Update-Script

URI: https://www.botlibre.com/rest/api/update-script
Operation: POST
Type: XML
スクリプトの内容を更新するために使用される更新スクリプト API。

Parameters

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

Update-Script-Icon

URI: https://www.botlibre.com/rest/api/update-script-icon
Operation: POST
Type: XML
スクリプトのアイコンを変更するために使用される更新スクリプトアイコンAPI。

Parameters

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

Check-Script

URI: https://www.botlibre.com/rest/api/check-script
Operation: POST
Type: XML
チェックフォーラム API はスクリプトを検証して返します。

Parameters

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

Delete-Script

URI: https://www.botlibre.com/rest/api/delete-script
Operation: POST
Type: XML
スクリプトを削除するためのスクリプト削除 API。

Parameters

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

Flag-Script

URI: https://www.botlibre.com/rest/api/flag-script
Operation: POST
Type: XML
スクリプトにフラグを付けるために使用されるフラグスクリプト API。

Parameters

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

Thumbs-Up-Script

URI: https://www.botlibre.com/rest/api/thumbs-up-script
Operation: POST
Type: XML
親指をスクリプトに配置するために使用される親指アップフォーラム API。

Parameters

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

Thumbs-Down-Script

URI: https://www.botlibre.com/rest/api/thumbs-down-script
Operation: POST
Type: XML
親指をスクリプトに配置するために使用される親指ダウンフォーラム API。

Parameters

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

Star-Script

URI: https://www.botlibre.com/rest/api/star-script
Operation: POST
Type: XML
スターフォーラムAPIは、ユーザーがスクリプトにスターを配置できるようにすることです。

Parameters

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

アバターのAPIのURL端

Get-Avatars

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

Parameters

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

Get-Avatar-Users

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

Parameters

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

Get-Avatar-Admins

URI: https://www.botlibre.com/rest/api/get-avatar-admins
Operation: POST
Type: XML
選択したアバターのすべての管理者を取得するために使用される get-avatar-admins API。

Parameters

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

Get-Avatar-Media

URI: https://www.botlibre.com/rest/api/get-avatar-media
Operation: POST
Type: XML
アバターのメディアを取得するために使用される、取得アバターメディア API。

Parameters

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

Create-Avatar

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

Parameters

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

Create-Avatar-Media

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

Parameters

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

Save-Avatar-Media

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

Parameters

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

Save-Avatar-Background

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

Parameters

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

Delete-Avatar

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

Parameters

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

Delete-Avatar-Media

URI: https://www.botlibre.com/rest/api/delete-avatar-media
Operation: POST
Type: XML
アバターのメディアを削除するために使用される、アバターの削除メディア API。

Parameters

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

Delete-Avatar-Background

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

Parameters

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

Check-Avatar

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

Parameters

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

Avatar-Message

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

Parameters

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

Star-Avatar

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

Parameters

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

Flag-Avatar

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

Parameters

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

Init-Avatar

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

Parameters

Parameter	Required	Type	Description

Update-Avatar

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

Parameters

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

Update-Avatar-Icon

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

Parameters

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

Thumbs-Up-Avatar

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

Parameters

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

Thumbs-Down-Avatar

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

Parameters

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

ドメインのURL端

Get-Domains

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

Parameters

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

Get-Domain-Users

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

Parameters

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

Get-Domain-Admins

URI: https://www.botlibre.com/rest/api/get-domain-admins
Operation: POST
Type: XML
ドメインのすべての管理者を取得するために使用される get-domain-admins API。

Parameters

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

Get-Domain

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

Parameters

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

Get-Domain-Icon

URI: https://www.botlibre.com/rest/api/get-domain-icon
Operation: POST
Type: XML
ドメインのアイコンを返すために使用される get ドメインアイコン API。

Parameters

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

Create-Domain

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

Parameters

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

Check-Domain

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

Parameters

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

Update-Domain

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

Parameters

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

Delete-Domain

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

Parameters

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

Flag-Domain

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

Parameters

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

Star-Domain

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

Parameters

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

Thumbs-Up-Domain

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

Parameters

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

Thumbs-Down-Domain

URI: https://www.botlibre.com/rest/api/thumbs-down-domain
Operation: POST
Type: XML
選択したドメインに対してサムダウンドメイン API を使用します。

Parameters

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

グラフィックURL端

Get-Graphics

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

Parameters

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

Get-Graphic-Users

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

Parameters

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

Get-Graphic-Admins

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

Parameters

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

Update-Graphic

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

Parameters

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

Update-Graphic-Icon

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

Parameters

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

Update-Graphic-Media

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

Parameters

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

Create-Graphic

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

Parameters

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

Delete-Graphic

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

Parameters

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

Check-Graphic

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

Parameters

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

Flag-Graphic

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

Parameters

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

Star-Graphic

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

Parameters

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

Thumbs-Up-Graphic

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

Parameters

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

Thumbs-Down-Graphic

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

Parameters

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

分析 URL エンドポイント

Get-Analytics

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

Parameters

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

Get-Analytic-Users

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

Parameters

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

Get-Analytic-Admins

URI: https://www.botlibre.com/rest/api/get-analytic-admins
Operation: POST
Type: XML
選択した分析のすべての管理者を取得するために使用される get-分析システム API。

Parameters

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

Test-Analytic

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

Parameters

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

Test-Audio-Analytic

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

Parameters

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

Test-Object-Detection-Analytic

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

Parameters

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

Get-Test-Media-Result

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

Parameters

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

Report-Media-Analytic

URI: https://www.botlibre.com/rest/api/report-media-analytic
Operation: POST
Type: XML
分析レポトを取得するために使用されるレポートメディア分析 API。

Parameters

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

Train-Analytic

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

Parameters

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

Delete-Analytic-Media

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

Parameters

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

Delete-Analytic-Test-Media

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

Parameters

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

Get-Analytic-Media

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

Parameters

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

Get-Analytic-Test-Media

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

Parameters

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

Create-Analytic-Label

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

Parameters

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

Create-Analytic-Test-Media-Label

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

Parameters

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

Delete-Analytic-Label

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

Parameters

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

Delete-Analytic-Test-Media-Label

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

Parameters

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

Check-Training

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

Parameters

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

Create-Analytic

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

Parameters

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

Update-Analytic

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

Parameters

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

Flag-Analytic

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

Parameters

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

Thumbs-Up-Analytic

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

Parameters

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

Thumbs-Down-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
分析に足を引くために使用されるサムダウン分析 API。

Parameters

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

Star-Analytic

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

Parameters

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

Delete-Analytic

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

Parameters

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

Check-Analytic

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

Parameters

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

Reset-Data-Analytic

URI: https://www.botlibre.com/rest/api/reset-data-analytic
Operation: POST
Type: XML
選択した分析のデータを残すために使用される残りのデータ分析 API。

Parameters

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

例

Test-Data-Analytic

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

Parameters

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

例

例結果

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

Train-Data-Analytic

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

Parameters

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

例

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