diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index b6fc4e601..52e6772fd 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -24,16 +24,6 @@ Accepts the following query string parameters: You can access a higher resolution mjpeg stream by appending `h=height-in-pixels` to the endpoint. For example `http://localhost:5000/api/back?h=1080`. You can also increase the FPS by appending `fps=frame-rate` to the URL such as `http://localhost:5000/api/back?fps=10` or both with `?fps=10&h=1000`. -### `GET /api///best.jpg[?h=300&crop=1&quality=70]` - -The best snapshot for any object type. It is a full resolution image by default. - -Example parameters: - -- `h=300`: resizes the image to 300 pixes tall -- `crop=1`: crops the image to the region of the detection rather than returning the entire image -- `quality=70`: sets the jpeg encoding quality (0-100) - ### `GET /api//latest.jpg[?h=300]` The most recent frame that frigate has finished processing. It is a full resolution image by default. @@ -200,6 +190,10 @@ Sets retain to false for the event id (event may be deleted quickly after removi Returns a thumbnail for the event id optimized for notifications. Works while the event is in progress and after completion. Passing `?format=android` will convert the thumbnail to 2:1 aspect ratio. +### `GET /api//