Create Event

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

Create Event

Request

Path Parameters

camera_name Camera Namerequired
label Labelrequired

application/json

Body

source_type object
anyOf
MOD1
string
MOD2
sub_label object
anyOf
MOD1
string
MOD2
score object
anyOf
MOD1
number
MOD2
duration object
anyOf
MOD1
integer
MOD2
include_recording object
anyOf
MOD1
boolean
MOD2
draw object
anyOf
MOD1
object
MOD2

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
MOD1
string
MOD2
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({
  "source_type": "string",
  "sub_label": "string",
  "score": 0,
  "duration": 0,
  "include_recording": True,
  "draw": {}
})
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

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

ResponseClear

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