Start recording export

POST 
https://demo.frigate.video/api/export/:camera_name/start/:start_time/end/:end_time

Starts an export of a recording for the specified time range. The export can be from recordings or preview footage. Returns the export ID if successful, or an error message if the camera is invalid or no recordings/previews are found for the time range.

Request

Path Parameters

camera_name objectrequired
start_time Start Timerequired
end_time End Timerequired

application/json

Bodyrequired

playbackPlayback factor (string)
Possible values: [realtime, timelapse_25x]
Default value: realtime
sourcePlayback source (string)
Possible values: [recordings, preview]
Default value: recordings
nameFriendly name (string)

Possible values: <= 256 characters

image_pathImage Path (string)

Responses

200

Successful Response

application/json

Schema

Schema

successSuccess (boolean)required

Whether the export was started successfully

messageMessage (string)required

Status or error message

export_id object
The export ID if successfully started
anyOf
string
string
null
null

Example (auto)

{
  "success": true,
  "message": "string",
  "export_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({
  "playback": "realtime",
  "source": "recordings",
  "name": "string",
  "image_path": "string"
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
conn.request("POST", "/api/export/:camera_name/start/:start_time/end/:end_time", 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

start_time — pathrequired

end_time — pathrequired

Body required

{
  "playback": "realtime",
  "source": "recordings",
  "name": "string",
  "image_path": "string"
}

ResponseClear

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