--- id: get-resized-photo sidebar_label: Get a Resized Photo hide_title: true hide_table_of_contents: true api: {"tags":["Photos"],"description":"Plex's Photo transcoder is used throughout the service to serve images at specified sizes.\n","operationId":"getResizedPhoto","parameters":[{"name":"width","description":"The width for the resized photo","in":"query","schema":{"type":"number","example":110},"required":true},{"name":"height","description":"The height for the resized photo","in":"query","schema":{"type":"number","example":165},"required":true},{"name":"opacity","description":"The opacity for the resized photo","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":100},"required":true},{"name":"blur","description":"The width for the resized photo","in":"query","schema":{"type":"number","example":[0,20,4000]},"required":true},{"name":"minSize","description":"images are always scaled proportionally. A value of '1' in minSize will make the smaller native dimension the dimension resized against.","in":"query","schema":{"type":"number","enum":[0,1]},"required":true},{"name":"upscale","description":"allow images to be resized beyond native dimensions.","in":"query","schema":{"type":"number","enum":[0,1]},"required":true},{"name":"url","description":"path to image within Plex","in":"query","schema":{"type":"string","example":"/library/metadata/49564/thumb/1654258204"},"required":true}],"responses":{"200":{"description":"Resized Image"},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number","example":1001},"message":{"type":"string","example":"User could not be authenticated"},"status":{"type":"number","example":401}}}}}}}}}},"method":"get","path":"/photo/:/transcode","servers":[{"url":"http://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}},{"url":"https://{Local IP}:{Port}","variables":{"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"Token":[],"ClientIdentifier":[],"Device":[],"DeviceName":[],"Platform":[],"PlatformVersion":[],"Product":[],"Version":[]}],"securitySchemes":{"Token":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Token"},"ClientIdentifier":{"description":"Plex Authentication Token","type":"apiKey","in":"header","name":"X-Plex-Client-Identifier"},"DeviceName":{"description":"Primary name for the device eg. `Plex Web (Chrome)`","type":"apiKey","in":"header","name":"X-Plex-Device-Name"},"Device":{"description":"The type of device your application is running on\nDevice name and or model number, eg `iPhone3,2`, `Motorola XOOMâ„¢`, `LG5200TV`\n","type":"apiKey","in":"header","name":"X-Plex-Device"},"PlatformVersion":{"description":"Operating system version\neg `4.3.1`, `10.6.7`, `3.2`\n","type":"apiKey","in":"header","name":"X-Plex-Platform-Version"},"Platform":{"description":"Platform name \neg: `Web`, `iOS`, `MacOSX`, `Android`, `LG`\n","type":"apiKey","in":"header","name":"X-Plex-Platform"},"Product":{"description":"Plex application name \neg: `Laika`, `Plex Media Server`, `Media Link`\n","type":"apiKey","in":"header","name":"X-Plex-Product"},"Version":{"description":"Plex application version number","type":"apiKey","in":"header","name":"X-Plex-Version"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.3","contact":{"name":"Luke Hagar","url":"https://www.LukeHagar.com","email":"Lukeslakemail@gmail.com"},"license":{"name":"MIT","identifier":"MIT","url":"https://opensource.org/licenses/MIT"}},"postman":{"name":"Get a Resized Photo","description":{"content":"Plex's Photo transcoder is used throughout the service to serve images at specified sizes.\n","type":"text/plain"},"url":{"path":["photo",":","transcode"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) The width for the resized photo","type":"text/plain"},"key":"width","value":""},{"disabled":false,"description":{"content":"(Required) The height for the resized photo","type":"text/plain"},"key":"height","value":""},{"disabled":false,"description":{"content":"(Required) The opacity for the resized photo","type":"text/plain"},"key":"opacity","value":""},{"disabled":false,"description":{"content":"(Required) The width for the resized photo","type":"text/plain"},"key":"blur","value":""},{"disabled":false,"description":{"content":"(Required) images are always scaled proportionally. A value of '1' in minSize will make the smaller native dimension the dimension resized against.","type":"text/plain"},"key":"minSize","value":""},{"disabled":false,"description":{"content":"(Required) allow images to be resized beyond native dimensions.","type":"text/plain"},"key":"upscale","value":""},{"disabled":false,"description":{"content":"(Required) path to image within Plex","type":"text/plain"},"key":"url","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/plex-media-server/plex-api --- import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem";

Get a Resized Photo

Plex's Photo transcoder is used throughout the service to serve images at specified sizes.
Query Parameters
Resized Image
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
Schema
    errors object[]
  • Array [
  • ]