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
    oneOf
    null
    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": "null",
          "relevanceScore": 0,
          "title": "string",
          "year": 0
        }
      ]
    }