API

ABM має REST API за адресою /api. Інтерактивний довідник лежить на /api/docs (Swagger) та /api/redoc, а схема на /api/openapi.json. Щоб прибрати всі три, задай DOCS_ENABLED=false. Сторінки документації завантажують ресурси з CDN, тож повністю відображаються лише з доступом до інтернету.

Автентифікація

• Ключ API: надсилай X-Api-Key: <key> або ?apikey=<key>. Знайти чи перегенерувати його можна в Settings > General > Security. Дивись Безпека.
• Bearer-токен, отриманий після входу.
• Облікові дані, які ти передаєш, мають пріоритет над обходом автентифікації, тож запит із ключем із локальної мережі вважається запитом до API.

Домовленості

• Помилки повертаються як {"detail": ...}.
• Секрети ніколи не повертаються. Відповідь лише каже, чи секрет задано.
• Запит із браузера, що змінює стан, мусить мати відповідне походження (origin). Скрипти з ключем від цього звільнені.
• Тіло запиту обмежене 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 може синхронізувати індексатори в ABM через своє з’єднання Prowlarr.