Event Snapshot

GET 
https://demo.frigate.video/api/events/:event_id/snapshot.jpg

Returns a snapshot image for the specified object id. NOTE: The query params only take affect while the event is in-progress. Once the event has ended the snapshot configuration is used.

Request

Path Parameters

event_id Event Idrequired

Query Parameters

download object
Default value: false
timestamp object
bbox object
crop object
height object
quality object
Default value: 70

Responses

200

Successful Response

application/json

Schema

Schema

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
string
string
integer
integer
]
msgMessage (string)required
typeError Type (string)required
]

Example (auto)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

• python
• nodejs
• javascript
• curl
• rust

• HTTP.CLIENT
• REQUESTS

import http.client

conn = http.client.HTTPSConnection("demo.frigate.video")
payload = ''
headers = {
  'Accept': 'application/json'
}
conn.request("GET", "/api/events/:event_id/snapshot.jpg", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://demo.frigate.video/api

Parameters

event_id — pathrequired

download — query

timestamp — query

bbox — query

crop — query

height — query

quality — query

ResponseClear

Click the Send API Request button above and see the response here!