[Bug]: Latest frame API can return code 500 for birdseye

[maksz42]

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

https://docs.frigate.video/integrations/api/latest-frame-camera-name-latest-extension-get/
Frigate returns 500 Internal Server Error if birdseye is disabled, but restream is enabled.

Moreover, Frigate produces a massive amount of error logs unrelated to the request when there's such a configuration.
I'm attaching the log file here because it's too long to paste (github returns 500, ironically).
frigate-logs.txt.gz

Steps to reproduce

1. Send a request to /api/birdseye/latest.jpeg

Version

0.16

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

No response

Frigate config file

birdseye:
  enabled: false
  restream: true

docker-compose file or Docker CLI command

n/a

Relevant Frigate log output

Too long, attached as a file

Relevant go2rtc log output

n/a

Operating system

Other Linux

Install method

Docker Compose

Network connection

Mixed

Camera make and model

n/a

Screenshots of the Frigate UI's System metrics pages

Any other information that may be helpful

For the request not to return 500, I guess a check if birdseye is enabled is needed here:

frigate/frigate/api/media.py

Line 204 in 6840415

elif camera_name == "birdseye" and request.app.frigate_config.birdseye.restream:

But for the error logs, I have no idea.

[inkeep-ai-assistant[bot]]

This is a configuration issue where you have birdseye disabled but restream enabled, which creates a conflict when the API tries to serve the birdseye latest frame(1)(2).

Based on the configuration reference, birdseye has two key settings(2):

birdseye:
  # Optional: Enable birdseye view (default: shown below)
  enabled: True
  # Optional: Restream birdseye via RTSP (default: shown below)
  # NOTE: Enabling this will set birdseye to run 24/7 which may increase CPU usage somewhat.
  restream: False

(2)

Your configuration has enabled: false but restream: true, which is problematic(2). The birdseye restream functionality requires birdseye to be enabled to function properly(1)(2).

To fix this issue, you have two options:

1. Enable birdseye completely:

birdseye:
  enabled: true
  restream: true

(2)

2. Disable both birdseye and restream:

birdseye:
  enabled: false
  restream: false

(2)

The documentation notes that enabling birdseye restream will cause birdseye to run 24/7 which may increase CPU usage somewhat(1)(2). If you don't need the birdseye functionality, it's better to disable both settings to avoid the 500 error and excessive logging.

📚 Sources:

1. Restream
2. Full Reference Config

---

Have another question? Just tag @inkeep.

[hawkeye217]

The AI is correct here, the configuration is problematic.

Nonetheless, this has been improved in #19573