Get Live JPG

Retrieve the single most recent jpeg image file for a given Accessory. This image generally will update once every 30 seconds to six minutes, but can update sooner if any Activity has taken place. You can use the refresh parameter to force a delayed wait to get the most recent from the camera. This call may block even if the refresh parameter is set to false. You MUST include an Accept: image/jpeg header in this call.

The response for this call will include a Last-Modified header to indicate when the snapshot was created in HTTP Date format. This can be used to show the user how old the snapshot is.

The width and height of the image is the same as the videoStream object found in results of Get Accessory by Id or Get All Accessories.

Permissions

Requires a Permissions scope of: circle:live_image

Language
Authentication
OAuth2