2021-01-22 14:34:40 +01:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "UTF-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< meta name = "generator" content = "Docusaurus v2.0.0-alpha.70" >
2021-01-22 14:50:27 +01:00
< link rel = "alternate" type = "application/rss+xml" href = "/frigate/blog/rss.xml" title = "Frigate Blog RSS Feed" >
< link rel = "alternate" type = "application/atom+xml" href = "/frigate/blog/atom.xml" title = "Frigate Blog Atom Feed" > < title data-react-helmet = "true" > HTTP API | Frigate< / title > < meta data-react-helmet = "true" name = "twitter:card" content = "summary_large_image" > < meta data-react-helmet = "true" name = "docusaurus_locale" content = "en" > < meta data-react-helmet = "true" name = "docusaurus_version" content = "current" > < meta data-react-helmet = "true" name = "docusaurus_tag" content = "docs-default-current" > < meta data-react-helmet = "true" property = "og:title" content = "HTTP API | Frigate" > < meta data-react-helmet = "true" name = "description" content = "A web server is available on port 5000 with the following endpoints." > < meta data-react-helmet = "true" property = "og:description" content = "A web server is available on port 5000 with the following endpoints." > < meta data-react-helmet = "true" property = "og:url" content = "https://blakeblackshear.github.io/frigate/usage/api" > < link data-react-helmet = "true" rel = "shortcut icon" href = "/frigate/img/favicon.ico" > < link data-react-helmet = "true" rel = "canonical" href = "https://blakeblackshear.github.io/frigate/usage/api" > < link rel = "stylesheet" href = "/frigate/styles.3cef2c0e.css" >
< link rel = "preload" href = "/frigate/styles.9ee538de.js" as = "script" >
< link rel = "preload" href = "/frigate/runtime~main.e5ee0dc0.js" as = "script" >
< link rel = "preload" href = "/frigate/main.a244e8e4.js" as = "script" >
< link rel = "preload" href = "/frigate/1.ae1576eb.js" as = "script" >
< link rel = "preload" href = "/frigate/2.0c8f52fa.js" as = "script" >
< link rel = "preload" href = "/frigate/24.22ef4830.js" as = "script" >
< link rel = "preload" href = "/frigate/935f2afb.a10c19ec.js" as = "script" >
< link rel = "preload" href = "/frigate/17896441.8d5dd138.js" as = "script" >
< link rel = "preload" href = "/frigate/72a19f07.a7e83a1a.js" as = "script" >
2021-01-22 14:34:40 +01:00
< / head >
< body >
< script > ! function ( ) { function t ( t ) { document . documentElement . setAttribute ( "data-theme" , t ) } var e = function ( ) { var t = null ; try { t = localStorage . getItem ( "theme" ) } catch ( t ) { } return t } ( ) ; t ( null !== e ? e : "light" ) } ( ) < / script > < div id = "__docusaurus" >
2021-01-22 14:50:27 +01:00
< nav aria-label = "Skip navigation links" > < button type = "button" tabindex = "0" class = "skipToContent_11B0" > Skip to main content< / button > < / nav > < nav class = "navbar navbar--fixed-top" > < div class = "navbar__inner" > < div class = "navbar__items" > < div aria-label = "Navigation bar toggle" class = "navbar__toggle" role = "button" tabindex = "0" > < svg aria-label = "Menu" width = "30" height = "30" viewBox = "0 0 30 30" role = "img" focusable = "false" > < title > Menu< / title > < path stroke = "currentColor" stroke-linecap = "round" stroke-miterlimit = "10" stroke-width = "2" d = "M4 7h22M4 15h22M4 23h22" > < / path > < / svg > < / div > < a class = "navbar__brand" href = "/frigate/" > < img src = "/frigate/img/logo.svg" alt = "Frigate" class = "themedImage_YANc themedImage--light_3CMI navbar__logo" > < img src = "/frigate/img/logo-dark.svg" alt = "Frigate" class = "themedImage_YANc themedImage--dark_3ARp navbar__logo" > < strong class = "navbar__title" > Frigate< / strong > < / a > < a class = "navbar__item navbar__link" href = "/frigate/" > Docs< / a > < / div > < div class = "navbar__items navbar__items--right" > < a href = "https://github.com/blakeblackshear/frigate" target = "_blank" rel = "noopener noreferrer" class = "navbar__item navbar__link" > GitHub< / a > < div class = "react-toggle react-toggle--disabled displayOnlyInLargeViewport_2N3Q" > < div class = "react-toggle-track" > < div class = "react-toggle-track-check" > < span class = "toggle_3NWk" > 🌜< / span > < / div > < div class = "react-toggle-track-x" > < span class = "toggle_3NWk" > 🌞< / span > < / div > < / div > < div class = "react-toggle-thumb" > < / div > < input type = "checkbox" disabled = "" aria-label = "Dark mode toggle" class = "react-toggle-screenreader-only" > < / div > < / div > < / div > < div role = "presentation" class = "navbar-sidebar__backdrop" > < / div > < div class = "navbar-sidebar" > < div class = "navbar-sidebar__brand" > < a class = "navbar__brand" href = "/frigate/" > < img src = "/frigate/img/logo.svg" alt = "Frigate" class = "themedImage_YANc themedImage--light_3CMI navbar__logo" > < img src = "/frigate/img/logo-dark.svg" alt = "Frigate" class = "themedImage_YANc themedImage--dark_3ARp navbar__logo" > < strong class = "navbar__title" > Frigate< / strong > < / a > < / div > < div class = "navbar-sidebar__items" > < div class = "menu" > < ul class = "menu__list" > < li class = "menu__list-item" > < a class = "menu__link" href = "/frigate/" > Docs< / a > < / li > < li class = "menu__list-item" > < a href = "https://github.com/blakeblackshear/frigate" target = "_blank" rel = "noopener noreferrer" class = "menu__link" > GitHub< / a > < / li > < / ul > < / div > < / div > < / div > < / nav > < div class = "main-wrapper" > < div class = "docPage_vMrn" > < div class = "docSidebarContainer_3Ak5" role = "complementary" > < div class = "sidebar_3gvy" > < div class = "menu menu--responsive thin-scrollbar menu_1yIk" > < button aria-label = "Open Menu" aria-haspopup = "true" class = "button button--secondary button--sm menu__button" type = "button" > < svg aria-label = "Menu" class = "sidebarMenuIcon_1CUI" width = "24" height = "24" viewBox = "0 0 30 30" role = "img" focusable = "false" > < title > Menu< / title > < path stroke = "currentColor" stroke-linecap = "round" stroke-miterlimit = "10" stroke-width = "2" d = "M4 7h22M4 15h22M4 23h22" > < / path > < / svg > < / button > < ul class = "menu__list" > < li class = "menu__list-item" > < a class = "menu__link menuLinkText_yu3-" > Frigate< / a > < ul class = "menu__list" > < li class = "menu__list-item" > < a class = "menu__link" tabindex = "0" href = "/frigate/" > Features< / a > < / li > < li class = "menu__list-item" > < a class = "menu__link" tabindex = "0" href = "/frigate/how-it-works" > How it works< / a > < / li > < li class = "menu__list-item" > < a class = "menu__link" tabindex = "0" href = "/frigate/hardware" > Recommended hardware< / a > < / li > < li class = "menu__list-item" > < a class = "menu__link" tabindex = "0" href = "/frigate/installation" > Installation< / a > < / li > < li class = "menu__list-item" > < a class = "menu__link" tabindex = "0" href = "/frigate/troubleshooting" > Troubleshooting< / a > < / li > < / ul > < / li > < li class = "menu__list-item" > < a class = "menu__link menuLinkText_yu3-" > Configuration< / a > < ul class = "menu__list" > < li class = "menu__list-item" > < a class = "menu__link" tabindex = "0" href = "/frigate/configuration/index" > Configuration< / a > < / li > < li class = "menu__list-item" > < a class = "menu__link" tabindex = "0" href = "/frigate/configuration/cameras" > Cameras< / a > < / li > < li class = "menu__list-item" > < a class = "menu__link" tabindex = "0" href = "/frigate/configu
|param|Type|Description|
|----|-----|--|
|< code > h< / code > |int|Height in pixels|
|< code > bbox< / code > |int|Show bounding boxes for detected objects (0 or 1)|
|< code > timestamp< / code > |int|Print the timestamp in the upper left (0 or 1)|
|< code > crop< / code > |int|Crop the snapshot to the (0 or 1)|< / p > < h3 > < a aria-hidden = "true" tabindex = "-1" class = "anchor enhancedAnchor_prK2" id = "clipscamera-idmp4" > < / a > < code > /clips/< camera> -< id> .mp4< / code > < a class = "hash-link" href = "#clipscamera-idmp4" title = "Direct link to heading" > #< / a > < / h3 > < p > Video clip for the given camera and event id.< / p > < h3 > < a aria-hidden = "true" tabindex = "-1" class = "anchor enhancedAnchor_prK2" id = "clipscamera-idjpg" > < / a > < code > /clips/< camera> -< id> .jpg< / code > < a class = "hash-link" href = "#clipscamera-idjpg" title = "Direct link to heading" > #< / a > < / h3 > < p > JPG snapshot for the given camera and event id.< / p > < / div > < / article > < div class = "margin-vert--xl" > < div class = "row" > < div class = "col" > < a href = "https://github.com/blakeblackshear/frigate/edit/master/docs/docs/usage/api.md" target = "_blank" rel = "noreferrer noopener" > < svg fill = "currentColor" height = "1.2em" width = "1.2em" preserveAspectRatio = "xMidYMid meet" role = "img" viewBox = "0 0 40 40" class = "iconEdit_2LL7" > < g > < path d = "m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z" > < / path > < / g > < / svg > Edit this page< / a > < / div > < / div > < / div > < div class = "margin-vert--lg" > < nav class = "pagination-nav" aria-label = "Blog list page navigation" > < div class = "pagination-nav__item" > < a class = "pagination-nav__link" href = "/frigate/usage/web" > < div class = "pagination-nav__sublabel" > Previous< / div > < div class = "pagination-nav__label" > « Web Interface< / div > < / a > < / div > < div class = "pagination-nav__item pagination-nav__item--next" > < a class = "pagination-nav__link" href = "/frigate/usage/mqtt" > < div class = "pagination-nav__sublabel" > Next< / div > < div class = "pagination-nav__label" > MQTT »< / div > < / a > < / div > < / nav > < / div > < / div > < / div > < div class = "col col--3" > < div class = "tableOfContents_2xL- thin-scrollbar" > < ul class = "table-of-contents table-of-contents__left-border" > < li > < a href = "#apicamera_name" class = "table-of-contents__link" > < code > /api/< camera_name> < / code > < / a > < / li > < li > < a href = "#apicamera_nameobject_namebestjpgh300crop1" class = "table-of-contents__link" > < code > /api/< camera_name> /< object_name> /best.jpg[?h=300& crop=1]< / code > < / a > < / li > < li > < a href = "#apicamera_namelatestjpgh300" class = "table-of-contents__link" > < code > /api/< camera_name> /latest.jpg[?h=300]< / code > < / a > < / li > < li > < a href = "#apistats" class = "table-of-contents__link" > < code > /api/stats< / code > < / a > < / li > < li > < a href = "#apiconfig" class = "table-of-contents__link" > < code > /api/config< / code > < / a > < / li > < li > < a href = "#apiversion" class = "table-of-contents__link" > < code > /api/version< / code > < / a > < / li > < li > < a href = "#apievents" class = "table-of-contents__link" > < code > /api/events< / code > < / a > < / li > < li > < a href = "#apieventssummary" class = "table-of-contents__link" > < code > /api/events/summary< / code > < / a > < / li > < li > < a href = "#apieventsid" class = "table-of-contents__link" > < code > /api/events/< id> < / code > < / a > < / li > < li > < a href = "#apieventsidthumbnailjpg" class = "table-of-contents__link" > < code > /api/events/< id> /thumbnail.jpg< / code > < / a > < / li > < li > < a href = "#apieventsidsnapshotjpg" class = "table-of-contents__link" > < code > /api/events/< id> /snapshot.jpg< / code > < / a > < / li > < li > < a href = "#clipscamera-idmp4" class = "table-of-contents__link" > < code > /clips/< camera> -< id> .mp4< / code > < / a > < / li > < li > < a href = "#clipscamera-idjpg" class = "table-of-contents__link" > < code > /clips/< camera> -< id> .jpg< / code > < / a > < / li > < / ul > < / div > < / div > < / div > < / div > < / main > < / div > < / div > < footer class = "footer footer--dark" > < div class = "container" > < div class = "row footer__links" > < div class = "col footer__col" > < h4 class = "footer__title" > Community< / h4 > < ul class = "footer__items" > < li class = "footer__item" > < a href = "https://github.com/blakeblackshear/frigate" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > GitHub< / a > < / li > < li class = "footer__item" > < a href = "https://github.com/blakeblackshear/frigate/discussions" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > Discussions< / a > < / li > < / ul > < / div > < / div > < div class = "footer__bottom text--center" > < div class = "footer__copyright" > Copyright © 2021 Blake Blackshear< /d
< script src = "/frigate/styles.9ee538de.js" > < / script >
< script src = "/frigate/runtime~main.e5ee0dc0.js" > < / script >
< script src = "/frigate/main.a244e8e4.js" > < / script >
< script src = "/frigate/1.ae1576eb.js" > < / script >
< script src = "/frigate/2.0c8f52fa.js" > < / script >
< script src = "/frigate/24.22ef4830.js" > < / script >
< script src = "/frigate/935f2afb.a10c19ec.js" > < / script >
< script src = "/frigate/17896441.8d5dd138.js" > < / script >
< script src = "/frigate/72a19f07.a7e83a1a.js" > < / script >
2021-01-22 14:34:40 +01:00
< / body >
< / html >
