Misskey.io で bot を作る ―― MiAuth からストリーミング API、そしてレートリミットとの戦い

MiAuth でトークンを取得する際、どのような権限（PERMISSION）を要求するかを指定します。 詳細は公式（ https://misskey-hub.net/ja/docs/for-developers/api/permission/ ）を参照して欲しいのですが、ここで一つ悩みどころがあります。

ドキュメントの記載だけだと、どの機能にどの権限が必要なのかがイマイチ分かりにくいのです。 例えば「投稿を取得したいだけ」なのに、どの read 権限を付ければいいのか、あるいは「ファイルをアップロードしたい」時にどの write 権限が必要なのか。

私の経験上、=write:notes=（投稿作成）や read:account=（アカウント情報取得）あたりは必須になることが多いでしょう。 =write:* 系や、 admin:* 系の権限は、万が一トークンが流出した際のリスクが極めて高いため、必須でない場合は避けましょう。

実際の取得手順は以下の通りです。

1. bot アカウントでログイン済みのブラウザで、次の URL にアクセスします。

   • https://misskey.io/miauth/$(UUID)?permission=$(PERMISSION)
   • ここで $(UUID) は適当な ID（UUID 形式）を自分で生成します。
   • $(PERMISSION) はカンマ区切りの権限リストです。
2. 画面に「連携を承認しますか？」といった内容が表示されるので、承認します。
3. 承認後、次の curl コマンドを実行してトークンを回収します。

1

  curl -v -X POST https://misskey.io/api/miauth/$(UUID)/check

ここで指定する UUID は、手順 1 で使用したものと同じでなければなりません。 成功すると、レスポンスの JSON 内に待望の token が含まれています。 これを大事に保管して bot のコードに組み込みます。

WebSocket でサーバと接続した後、どの「チャンネル」を購読（connect）するかを決定します。

• homeTimeline: 自分のフォローしているユーザーの投稿が流れます。bot の自分宛てのメンションに反応する場合などはここを使います。
• localTimeline: インスタンス全体の投稿が流れます。いわゆる「LTL」です。

開発初期の動作確認であれば、投稿頻度の高い localTimeline に接続して、次々と流れてくる JSON を眺めるのが手っ取り早いです。 ただし、Misskey.io の LTL は濁流のような勢いで流れてくるため、不用意に全てのログを出力するとコンソールが浦島太郎状態になるので注意が必要です。

ファイルのアップロードについては、こちらの API ドキュメント（ https://api-doc.misskey.io/api-7254083 ）が参考になりますが、ここで大きなハマりポイントがあります。

Misskey では、同じ内容のファイルは基本的に 1 つしか存在できないようです。

つまり、異なるファイル名であってもハッシュ値（バイナリの内容）が同じファイルを再度アップロードしようとすると、既存のファイル ID が返ってくる挙動になります。 「bot が定期的に同じ画像を投稿する」ような実装をする場合、毎回アップロードを試みるのではなく、一度アップロードした際の fileId を再利用する設計にする必要があります。 これを無視して毎回アップロードしようとすると、無駄な API コールが増えるだけでなく、後述するレートリミットにも引っかかりやすくなります。

ファイルを整理するために、ドライブ内にフォルダを作成することも可能です（ https://api-doc.misskey.io/api-7254091 ）。 事前にフォルダを作成、あるいは参照して folderId を取得しておき、アップロード時にそれを指定します。 bot 用の画像がドライブのルートに散らばっているのは精神衛生上よろしくないので、ディレクトリ構造を整えるのは基本ですね。

ファイルの準備ができたら、=notes/create=（ https://api-doc.misskey.io/api-7254018 ）の引数 fileIds に、取得した ID の配列を指定して投稿します。 これで、画像付きの投稿が完了します。

ネットを検索しても、具体的な「1 分間に何回まで」という数値は見当たりませんでした。 インスタンスの設定（config）に依存するため、管理者以外には分からないブラックボックスです。 ただ、感覚としては数分間に数十回程度リクエストを送るとロックがかかるような印象です。

一度レートリミットに引っかかると、しばらくロックがかかります。 私の環境で実測した限りでは、*約 40 分程度* 経過すると自動的に解除されるようです。