---
id: screen-shot-image
title: "Get Screenshot Image"
description: "Retrieve the current screenshot image."
sidebar_label: "Get Screenshot Image"
hide_title: true
hide_table_of_contents: true
api: eJzVV91v2zgM/1cIDRg2w3Gy9u4lb70styv2dWiy28NaHBSbsdXIkifK6XJB/vcDJTtfbYG97imxRJE/UuSP1FZ4WZIYfxPO2npAuUM04i4VBVLuVOOVNWIsbtA7hWsEXyHkrXNoPERhqqwHVcsSM5EK26CTfOi6EGMRJWaV9dcsIFLRSCdr9OjY5lYoVv69RbcRqTCyxvAptfK8cIohqIBuF16NBm9Go9ds0+H3VjksxHgpNWEqKK+wlmK8FX7TsEplPJboxG53x+LUWENILHAxGvHPqaXZmWPgOvcLoDbPkWjZar1h27k1Ho1nHUF0eN9gyV+PMJB3ypQiFUvraunFWCyUkW4jdrvdLhW/jd48BjKv2Pb3FslD5yVBS+hAtr5C41Uegn2GRDaN7naG98SansBjF/eYe74Sx5fmVQxIjUR8VU8AP8X2Fr1UGgtA56yD7lwm2BmvvOajU9762Gns/bx82k9Ct0YHrSnQkbe2CLnWeZ/CouUQLFtCAm+D/9ap/xCU/4W8//2pdPti5EIje5U7lB4P1fRLeLVLRY2+slzwJQbr0ldiLIayUUOmlWHkgSFXVHbfsN1425EETjF8sLnUXTaIVLROi7GovG/Gw6HmvcqSH1+ORiPB1UyYt47pgjX9gdKhu2rZ/Le7XboVE2tXCo9X5naFZr9wpGHG0YwBOz61j5ls1HtkWgqklQeRA2t9mr7//O9sOptdf/70KK5XJ9UKLSlTggRCIv6OujKxS0882Ftm70VHa/y9CEI/ayWqBM9+BxtHEXjGuTNGDkd/1lwQhkYSYQGSQELQBnvmj+mkzNIG+11afcKVhau/r0UqODGiictslI0eGQ6igQi+4uJmPgFpCv47s/kKPSyQVIEEN9PZnDVyYTXOrlXBdCL1wKsagT8tkHcoa2XKFLhHOJl7tUbIrdZyYWMnS4N+h7X1CAXSytsGlq3JeTM0o+zW3JoXL17AxDqEOeaVsdqWCok3BpAk/wRrs94aWKa6iD5Jbg3AAIJXGtfoZIkESdJvw9K6A/AUtH0YaOnR5JsUKlVWg74nRp8YrWwLdeRdFk28x83CSlcEkdq2hIBrNJ5AOgTvpKFaeY9FxMf8S7LGPsy5NQaD1wESoaw1Eh0iZ03WO3zDeOcc6JkqOUqcG6aAia3r1vQ504ch3lwfieB6vwQqdLwimjwoU6aH9QqzMkv3xYTk5UIrqmo0PoXryRRyaQpVMLPij7ySpsTXGUA09iHcdyX9QUPbsCzFe191MRvGeC2l1guZr0LEKmkK3Udrj/kQgz4BGfp0jW7jK4Y+1YQHX8/K6CXMOhgfpZElshdJAgOYMU3hU90/4OzBB0x85b2DSXJjbR1kvvDZM7UTbjmhAGpbqOUm/GVh7j3O6hDsaDRMPlxNzOl0ZOBtVxSTeISC4qviviXW3M2JrHCpyjYWFaVQMxDeXz2XlllvYLYhjzX8hVL7Cl7CR57H8minG02DoShWRbG8wnxFQel+KpUalCFVVj7ij2X7l32Aaw9XWsNX61YEc1uir9CxwJvsuBbjlRPUWCh5KLBwxUlyRi9pV4cMoZBeJkl2ay6yswRHQy3PdRKSpGHqIx8yd6EK5bBjmSQ5L78jGjiuwOjXZXaUf0nS8x/TylIZHJROKoP7S06SmMNH99yxHqfOycWF7P6ThwPmuiIMDJTyaBZ6TCANno5D4hc2bznT+pMiFVrlaCjMIl13uWpkXiFcBKY/afcPDw+ZDLuZdeWwO0rDD9eT6afZdHCRjbLK1zo0lMaSr6U5UvwOPRyN8v0T5KSZbA8z1s8/crqe6fGHHzZaKsNdNSDfdrPPN26o/DSxtg6dOzyrUrGfgO5SwXMMS263C0n4xendjpdj7w1zkSIeDA/vmmeRP/s0ehLpCjcnz6y11C1LhXlqLZ1iq3FcEhXKAl2AE49d5Tk2/ujU0bOHz+9HwXfTudjt/gcj/vim
sidebar_class_name: "get api-method"
info_path: docs/v3/api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Get Screenshot Image"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/api/room/screen/shot.jpg"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Retrieve the current screenshot image.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"quality","description":"Image quality (0-100).","required":false,"schema":{"type":"integer"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Screenshot image retrieved successfully.","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"500":{"description":"Unable to create image.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
  
</StatusCodes>