API

認証、ドキュメントページ、制限。

ABM には /api の下に REST API があります。インタラクティブなリファレンスは /api/docs（Swagger）と /api/redoc、スキーマは /api/openapi.json にあります。DOCS_ENABLED=false にすると3つとも消えます。ドキュメントページはアセットを CDN から読み込むので、ちゃんと表示されるのはインターネットにつながっているときだけです。

認証

API キー：X-Api-Key: <key> か ?apikey=<key> を送ります。キーの確認と再発行は Settings > General > Security でできます。セキュリティを見てください。
サインインで得られる Bearer トークン。
認証情報を提示した場合はバイパスより優先されるので、LAN からキー付きで送ったリクエストは API リクエストとして扱われます。

決まりごと

エラーは {"detail": ...} で返ってきます。
シークレットが返されることはありません。レスポンスには設定されているかどうかだけが入ります。
状態を変えるブラウザからのリクエストは、オリジンが一致している必要があります。キーを使うスクリプトは対象外です。
リクエストボディの上限は 10 MiB です（MAX_REQUEST_BODY_BYTES）。バックアップの復元と表紙のアップロードは上限が大きめです。上限を超えると HTTP 413 になります。
バリデーションエラーで、送った内容がそのまま返されることはありません。

メタデータの障害

Libex から応答がない本の検索は、502 と “Libex search failed” を返します。著者やシリーズの検索は、503 と “Libex could not be reached; try again shortly” を返します。障害中でも、一部の検索ルートは空の結果を返します。

Sonarr を知っているなら：この API は v3 互換ではありません。Prowlarr は自身の Prowlarr 連携を通じて ABM にインデクサーを同期できます。