Skip to main content

PluginSearchResponse

Response containing search results from a plugin

nextCursorstring | nullnullable

Cursor for next page (if available)

pluginIdstring<uuid>required

Plugin that provided the results

pluginNamestringrequired

Plugin name

results object[]required

Search results

  • Array [
  • alternateTitlesstring[]

    Alternative titles

    coverUrlstring | nullnullable

    Cover image URL

    externalIdstringrequired

    External ID from the provider

    preview object

    Preview data for search results

    authorsstring[]

    Author names (book search results)

    bookCountinteger,null<int32>nullable

    Number of books in the series (if known by the provider)

    descriptionstring | nullnullable

    Short description

    formatstring | nullnullable

    Content format discriminator (e.g. manga, novel, light_novel, manhwa, manhua, comic, webtoon, one_shot).

    Free-form string at the protocol layer; the UI maps known values to colored badges and falls back to a neutral badge for anything else.

    genresstring[]

    Genres

    ratingnumber,null<double>nullable

    Rating

    statusstring | nullnullable

    Status string (series search results)

    relevanceScorenumber,null<double>nullable

    Relevance score (0.0-1.0). Optional - if not provided, result order indicates relevance.

    titlestringrequired

    Primary title

    yearinteger,null<int32>nullable

    Year of publication

  • ]
  • PluginSearchResponse
    {
    "nextCursor": "string",
    "pluginId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pluginName": "string",
    "results": [
    {
    "alternateTitles": [
    "string"
    ],
    "coverUrl": "string",
    "externalId": "string",
    "preview": {
    "authors": [
    "string"
    ],
    "bookCount": 0,
    "description": "string",
    "format": "string",
    "genres": [
    "string"
    ],
    "rating": 0,
    "status": "string"
    },
    "relevanceScore": 0,
    "title": "string",
    "year": 0
    }
    ]
    }