Perform a voice search

This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the /hubs/search endpoint. It uses a Levenshtein distance heuristic to search titles, and as such is much slower than the other search endpoint. Whenever possible, clients should limit the search to the appropriate type. Results, as well as their containing per-type hubs, contain a distance attribute which can be used to judge result quality.

GET

hubs

voice

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Search.PerformVoiceSearchAsync(
    query: "dead+poop",
    sectionId: 4094.8D,
    limit: 5D
);

// handle response

This response does not have an example.

Authorizations

X-Plex-Token

string

header

required

Plex Authentication Token

Query Parameters

query

string

required

The query term

Examples:

"dead+poop"

sectionId

number

This gives context to the search, and can result in re-ordering of search result hubs

limit

number

default:3

The number of items to return per hub

Example:

5

Response

200

The search results

Perform a search Get Search Results

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Search.PerformVoiceSearchAsync(
    query: "dead+poop",
    sectionId: 4094.8D,
    limit: 5D
);

// handle response

This response does not have an example.

Server

Media

Video

Activities

Butler

Plex

Hubs

Search

Library

Watchlist

Log

Playlists

Authentication

Statistics

Sessions

Updater

Users

Perform a voice search

Authorizations

Query Parameters

Response