[Bug]: api/events timestamp & bbox parameters seem to be ignored

[raintonr]

Checklist

• I have updated to the latest available Frigate version.
• I have cleared the cache of my browser.
• I have tried a different browser to see if it is related to my browser.
• I have tried reproducing the issue in incognito mode to rule out problems with any third party extensions or plugins I have installed.

Describe the problem you are having

When using the API to fetch an event snapshot the default appears to be to include timestamp and bounding box, which yields something like this (from Frigate demo server):

If one wants a 'clean' image with no annotation, according to the docs here...

https://docs.frigate.video/integrations/api/event-snapshot-events-event-id-snapshot-jpg-get

... we can add parameters like this:

https://demo.frigate.video/api/events/1743697462.544662-zyfonl/snapshot.jpg?timestamp=0&bbox=0

However, these parameters seem to be ignored and the exact same image is returned.

Steps to reproduce

1. Fetch this image: https://demo.frigate.video/api/events/1743697462.544662-zyfonl/snapshot.jpg
2. Fetch this image: https://demo.frigate.video/api/events/1743697462.544662-zyfonl/snapshot.jpg?timestamp=0&bbox=0
3. Fetch this image: https://demo.frigate.video/api/events/1743697462.544662-zyfonl/snapshot.jpg?timestamp=0&bbox=1

The above should all be different, but the exact same image is returned.

Version

0.15.0-844b6592

In which browser(s) are you experiencing the issue with?

No response

Frigate config file

N/A - look at the demo system.

docker-compose file or Docker CLI command

N/A - look at the demo system.

Relevant Frigate log output

N/A - look at the demo system.

Relevant go2rtc log output

N/A - look at the demo system.

Operating system

Other Linux

Install method

Docker Compose

Network connection

Wired

Camera make and model

N/A

Screenshots of the Frigate UI's System metrics pages

N/A - look at the demo system.

Any other information that may be helpful

No response

[NickM-27]

this is not a bug. These api parameters only work while the object is in progress. Once the object ends a snapshot is saved and the api parameters will not take affect

[raintonr]

Do you collect analytics on which APIs are used? I use the snapshot one all the time 😁

[NickM-27]

to be clear I meant used in Frigate and related tools directly, not custom use cases, and no we don't have any analytics capturing given the nature of frigate and local control in general.

for now you can just configure the snapshots config to be how you want it, we will update the api docs to reflect the behavior

[raintonr]

for now you can just configure the snapshots config to be how you want it...

Sadly I don't think that is possible as I like annotations in the UI, but want a file without them for testing other stuff. Aside from what the API docs referenced above say, this is what config says about snapshots:

# Optional: Configuration for the jpg snapshots written to the clips directory for each tracked object
# NOTE: Can be overridden at the camera level
snapshots:
  # Optional: Enable writing jpg snapshot to /media/frigate/clips (default: shown below)
  enabled: False
  # Optional: save a clean PNG copy of the snapshot image (default: shown below)
  clean_copy: True
  # Optional: print a timestamp on the snapshots (default: shown below)
  timestamp: False
  # Optional: draw bounding box on the snapshots (default: shown below)
  bounding_box: True
  # Optional: crop the snapshot (default: shown below)
  crop: False

So just a second... this clean_copy items looks interesting! I didn't know about that, and indeed I can see PNG snapshot copies in the Frigate media folder. I don't know why this is PNG and not JPG, but I digress - I can use that file for my purposes right now.

You could also have the API return that file when no annotations are required. Or you could have a clean_copy parameter that is mutually exclusive to the annotation parameters and returns the clean_copy file when it exists (or 404 if not configured, etc).

However, I would class that as a workaround. IMHO the correct solution is what I mentioned in #17524 (reply in thread)

[NickM-27]

You could also have the API return that file when no annotations are required. Or you could have a clean_copy parameter that is mutually exclusive to the annotation parameters and returns the clean_copy file when it exists (or 404 if not configured, etc).

There's already a separate API to get the clean copy

https://docs.frigate.video/integrations/api/event-snapshot-clean-events-event-id-snapshot-clean-png-get