Create manual event

POST 
https://demo.frigate.video/api/events/:camera_name/:label/create

Creates a manual event in the database. Returns a success message or an error if the event is not found. NOTES:

• Creating a manual event does not trigger an update to /events MQTT topic.
• If a duration is set to null, the event will need to be ended manually by calling /events/{event_id}/end.

Request

Path Parameters

camera_name Camera Namerequired
label Labelrequired

application/json

Body

sub_label object
anyOf
string
string
null
null
score object
anyOf
number
number
null
null
duration object
anyOf
integer
integer
null
null
include_recording object
anyOf
boolean
boolean
null
null
draw object
anyOf
object
object
null
null
pre_capture object
anyOf
integer
integer
null
null

Responses

200

Successful Response

application/json

Schema

Schema

successSuccess (boolean)required
messageMessage (string)required
event_idEvent Id (string)required

Example (auto)

{
  "success": true,
  "message": "string",
  "event_id": "string"
}

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
import json

conn = http.client.HTTPSConnection("demo.frigate.video")
payload = json.dumps({
  "sub_label": "string",
  "score": 0,
  "duration": 0,
  "include_recording": True,
  "draw": {},
  "pre_capture": 0
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
conn.request("POST", "/api/events/:camera_name/:label/create", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://demo.frigate.video/api

Parameters

camera_name — pathrequired

label — pathrequired

Body

{
  "sub_label": "string",
  "score": 0,
  "duration": 0,
  "include_recording": true,
  "draw": {},
  "pre_capture": 0
}

ResponseClear

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