Skip to main content

PluginWebLinksResponse

Response shape for GET /api/v1/plugins/web-links.

providers object[]required

One entry per enabled plugin declaring the webLinks capability whose search template resolved against its config.

  • Array [
  • displayNamestringrequired

    Human-readable label for the button; falls back to the plugin name when no display name is configured.

    pluginNamestringrequired

    Plugin name (stable identifier).

    searchUrlTemplatestringrequired

    Search page template. The only remaining placeholder is {title}, filled client-side with the URL-encoded series title.

    seriesLinks object[]required

    Ordered direct-link templates; the first entry whose source the series has an external ID for wins. When none match, the frontend falls back to search_url_template.

  • Array [
  • sourcestringrequired

    Bare Codex external-ID source name, e.g. mangabaka, myanimelist.

    urlTemplatestringrequired

    URL template with config placeholders already substituted. The only remaining placeholder is {externalId}, filled client-side.

  • ]
  • ]
  • PluginWebLinksResponse
    {
    "providers": [
    {
    "displayName": "string",
    "pluginName": "string",
    "searchUrlTemplate": "string",
    "seriesLinks": [
    {
    "source": "string",
    "urlTemplate": "string"
    }
    ]
    }
    ]
    }