Skip to main content

PluginActionRequest

Plugin action request - tagged by plugin type

Each plugin type has its own set of valid actions. This ensures type safety - you can't call a metadata action on a sync plugin.

oneOf
metadata objectrequired

Metadata plugin actions (search, get, match)

actionMetadataAction (string)required

The metadata action to perform

Possible values: [search, get, match]

contentTypeMetadataContentType (string)required

Content type (series or book)

Possible values: [series, book]

params

Action-specific parameters

PluginActionRequest
{
"metadata": {
"action": "search",
"contentType": "series"
}
}