assemblrr/docs/api-reference.md
soulis-1256 0858a5a629
Drop Portainer from default stack; harden upgrade and setup UX
Remove Portainer from managed compose and catalog; leave a custom.yaml
example for optional use. Upgrade/start use compose --remove-orphans and
migration 002 removes leftover Portainer containers unless custom.yaml
keeps it. Fix setup double URL list when status is unhealthy, share
OpenSubtitles y/N on express, and tone down indexer/provider prompts.
2026-08-12 15:26:21 +03:00

31 lines
1.4 KiB
Markdown

# assemblrr API Reference
This document aggregates the official API documentation for all services used by assemblrr.
## Media Services
| Service | API Documentation | Notes |
|---------|-------------------|-------|
| **Jellyfin** | https://api.jellyfin.org/openapi/jellyfin-openapi-stable.json | Raw OpenAPI JSON; alternative Mintlify: https://mintlify.com/jellyfin/jellyfin |
| **Emby** | https://app.swaggerhub.com/apis-docs/MediaBrowser/Emby.Api | Outdated spec; Emby and Jellyfin share origins but their APIs diverged — not interchangeable |
| **Plex** | https://www.plexopedia.com/plex-media-server/api | Unofficial but comprehensive; official docs require login |
## *arr Stack (Servarr Family)
| Service | API Documentation | Notes |
|---------|-------------------|-------|
| **Prowlarr** | https://prowlarr.com/docs/api/ | OpenAPI/Swagger UI |
| **Sonarr** | https://sonarr.tv/docs/api/ | v3 API covers v3 and v4 |
| **Radarr** | https://radarr.video/docs/api/ | OpenAPI/Swagger UI |
| **Bazarr** | https://wiki.bazarr.media/ | Companion subtitle manager; API via `/api/` with `apikey` |
### Servarr Wiki
- **URL:** https://wiki.servarr.com/
- Contains setup guides, configuration tutorials, and troubleshooting for all *arr services.
## Request Management
| Service | API Documentation | Notes |
|---------|-------------------|-------|
| **Seerr** | https://api-docs.overseerr.dev/ | Swagger UI |