GET
/
library
/
metadata
/
{ratingKey}
/
banner
declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;

$sdk = Plex_API\PlexAPI::builder()
    ->setSecurity(
        '<YOUR_API_KEY_HERE>'
    )
    ->build();

$request = new Operations\GetBannerImageRequest(
    ratingKey: 9518,
    width: 396,
    height: 396,
    minSize: 1,
    upscale: 1,
    xPlexToken: 'CV5xoxjTpFKUzBTShsaf',
);

$response = $sdk->media->getBannerImage(
    request: $request
);

if ($response->bytes !== null) {
    // handle response
}
This response does not have an example.

Authorizations

​
X-Plex-Token
string
header
required

Plex Authentication Token

Headers

​
X-Plex-Token
string
required

An authentication token, obtained from plex.tv

Example:

"CV5xoxjTpFKUzBTShsaf"

Path Parameters

​
ratingKey
integer
required

the id of the library item to return the children of.

Example:

9518

Query Parameters

​
width
integer
required
Example:

396

​
height
integer
required
Example:

396

​
minSize
integer
required
Example:

1

​
upscale
integer
required
Example:

1

Response

200
image/jpeg
Successful response returning an image

The response is of type file.

Update Media Play ProgressGet Thumb Image