Skip to main content

PluginCapabilitiesDto

Plugin capabilities

externalIdSourcestring | nullnullable

External ID source for matching sync entries to series (e.g., "api:anilist")

metadataProviderstring[]

Content types this plugin can provide metadata for (e.g., ["series", "book"])

releaseSourceboolean

Whether the plugin declares the release_source capability (announces new chapter / volume releases for tracked series).

userReadSyncboolean

Can sync user reading progress

userRecommendationProviderboolean

Can provide personalized recommendations

wantsDetailedProgressboolean

Whether the plugin consumes the per-book reading-progress breakdown on the sync entries it receives. Only meaningful when user_read_sync is true.

wantsFullMetadataboolean

Whether the plugin consumes enriched series data (bibliographic metadata, custom metadata) on the sync/recommendation entries it receives.

PluginCapabilitiesDto
{
  "externalIdSource": "string",
  "metadataProvider": [
    "string"
  ],
  "releaseSource": true,
  "userReadSync": true,
  "userRecommendationProvider": true,
  "wantsDetailedProgress": true,
  "wantsFullMetadata": true
}