公開APIでできること

みくみくまうすの公開APIを用いることで以下の機能を利用することができます

  • メッセージの読み上げ
  • 読み上げ時の感情モーションの指定
  • タグによる読み上げメッセージのフィルタリング
  • キャラクタの衣装等の変更

公開APIを利用したアプリについて

公開APIを利用して作成されたアプリは自由に公開・配布・展示をしてもらって構いません
ただし、その際は必ずみくみくまうすを利用している事を明記してください
また、開発したアプリの紹介動画をニコニコ動画に投稿する場合はこちらの動画をコンテンツツリーの親に登録してください
公開・配布・展示の際にみくみくまうす作者への連絡は不要です(けど教えて頂けると喜びます)

対応プロトコル

プロトコル一覧

プロトコルデータフォーマット詳細
ソケット通信(TCP)JSONみくみくまうすがクライアントとなり指定したホストへ接続します
WebSocketJSONみくみくまうすがクライアントとなり指定したホストへ接続します
HTTP(REST API)JSONみくみくまうすがHTTPサーバとしてHTTPを待ち受けます

使用するプロトコルは設定画面より切り替えることが出来ます

ソケット通信 & WebSocket

ソケット通信またはWebSocketを用いる場合、みくみくまうすはクライアントとして動作します
開発アプリ側で各サーバを準備してください

サーバへの接続はキャラクタが画面に表示された際に行われます
(接続に失敗した場合、定期的(5秒間隔)に再接続を試みます)

ソケット通信またはWebSocketを利用した場合、みくみくまうすを多重起動して同時に操作することが可能です
複数起動したうちの特定のキャラクタのみに喋らせたいといった場合は後述の「タグ」機能を利用すると良いでしょう

HTTP(REST API)

みくみくまうすは以下のREST APIを提供します
URIメソッドContent-Type 機能
/talkPOSTapplication/json指定した文章を読み上げます
/characterPUTapplication/jsonキャラクタの状態を変更します

JSONフォーマット

別ページへ

問い合わせ・不具合報告・要望について

tori.birdstrike[a]gmail.com へメール、またはTwitterへお願いします
(忙しい場合は返事できない可能性があります ご了承ください)