From e12116693dca2abca374c014dbf5172160197e7c Mon Sep 17 00:00:00 2001 From: Nick Mowen Date: Tue, 15 Feb 2022 22:43:25 -0700 Subject: [PATCH] Update docs for new endpoint and features --- docs/docs/integrations/api.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/docs/integrations/api.md b/docs/docs/integrations/api.md index 69b6e7632..b3d03e238 100644 --- a/docs/docs/integrations/api.md +++ b/docs/docs/integrations/api.md @@ -24,9 +24,10 @@ 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]` +### `GET /api///latest.jpg[?h=300&crop=1&quality=70]` -The best snapshot for any object type. It is a full resolution image by default. +The snapshot from the latest event for a given object type. It is a full resolution image by default. +`any` can be passed as the `object_name` to get snapshot from the latest event regardless of object type. Example parameters: