(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{80:function(e,t,a){"use strict";a.r(t),a.d(t,"frontMatter",(function(){returni})),a.d(t,"metadata",(function(){returnl})),a.d(t,"toc",(function(){returnc})),a.d(t,"default",(function(){returno}));varn=a(3),r=a(7),b=(a(0),a(99)),i={id:"api",title:"HTTP API"},l={unversionedId:"usage/api",id:"usage/api",isDocsHomePage:!1,title:"HTTP API",description:"A web server is available on port 5000 with the following endpoints.",source:"@site/docs/usage/api.md",slug:"/usage/api",permalink:"/frigate/usage/api",editUrl:"https://github.com/blakeblackshear/frigate/edit/master/docs/docs/usage/api.md",version:"current",sidebar:"docs",previous:{title:"Web Interface",permalink:"/frigate/usage/web"},next:{title:"MQTT",permalink:"/frigate/usage/mqtt"}},c=[{value:"<code>/api/<camera_name></code>",id:"apicamera_name",children:[]},{value:"<code>/api/<camera_name>/<object_name>/best.jpg[?h=300&crop=1]</code>",id:"apicamera_nameobject_namebestjpgh300crop1",children:[]},{value:"<code>/api/<camera_name>/latest.jpg[?h=300]</code>",id:"apicamera_namelatestjpgh300",children:[]},{value:"<code>/api/stats</code>",id:"apistats",children:[]},{value:"<code>/api/config</code>",id:"apiconfig",children:[]},{value:"<code>/api/version</code>",id:"apiversion",children:[]},{value:"<code>/api/events</code>",id:"apievents",children:[]},{value:"<code>/api/events/summary</code>",id:"apieventssummary",children:[]},{value:"<code>/api/events/<id></code>",id:"apieventsid",children:[]},{value:"<code>/api/events/<id>/thumbnail.jpg</code>",id:"apieventsidthumbnailjpg",children:[]},{value:"<code>/api/events/<id>/snapshot.jpg</code>",id:"apieventsidsnapshotjpg",children:[]},{value:"<code>/clips/<camera>-<id>.mp4</code>",id:"clipscamera-idmp4",children:[]},{value:"<code>/clips/<camera>-<id>.jpg</code>",id:"clipscamera-idjpg",children:[]}],p={toc:c};functiono(e){vart=e.components,a=Object(r.a)(e,["components"]);returnObject(b.b)("wrapper",Object(n.a)({},p,a,{components:t,mdxType:"MDXLayout"}),Object(b.b)("p",null,"A web server is available on port 5000 with the following endpoints."),Object(b.b)("h3",{id:"apicamera_name"},Object(b.b)("inlineCode",{parentName:"h3"},"/api/<camera_name>")),Object(b.b)("p",null,"An mjpeg stream for debugging. Keep in mind the mjpeg endpoint is for debugging only and will put additional load on the system when in use."),Object(b.b)("p",null,"Accepts the following query string parameters:"),Object(b.b)("table",null,Object(b.b)("thead",{parentName:"table"},Object(b.b)("tr",{parentName:"thead"},Object(b.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"param"),Object(b.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Type"),Object(b.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"Description"))),Object(b.b)("tbody",{parentName:"table"},Object(b.b)("tr",{parentName:"tbody"},Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(b.b)("inlineCode",{parentName:"td"},"fps")),Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"int"),Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Frame rate")),Object(b.b)("tr",{parentName:"tbody"},Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(b.b)("inlineCode",{parentName:"td"},"h")),Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"int"),Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Height in pixels")),Object(b.b)("tr",{parentName:"tbody"},Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(b.b)("inlineCode",{parentName:"td"},"bbox")),Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"int"),Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"Show bounding boxes for detected objects (0 or 1)")),Object(b.b)("tr",{parentName:"tbody"},Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(b.b)("inlineCode",{parentName:"td"},"timestamp")),Object(b.b)("td",Object(n.a)({parentName:"tr"},{align:null}),"int"),Object(b.b)("td",Object(n.a)({parentName:"tr"}
