API Reference
Getting startedVisit een.comMy Application/Login

/exports

post
https://{BaseUrl}/api/v3.0/exports

Creates and starts a new video export job

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The ID of the device

string
enum
required

Type of export to make. Should be one of: video, timeLapse or bundle. Where:

  • video: Export the full video interval(s) between the given times to mp4.
  • timeLapse: Export the preview video as a time lapse video to mp4.
  • bundle: combination of video and timeLapse.
Allowed:
boolean
Defaults to false

If true the export is placed into the read-only "downloads" folder of archive, and will be removed after 2 weeks. Else the export is placed in archive with the end user having full control over it.

boolean
Defaults to false

If true: the job will not try to sync any data to the cloud, instead the export will only contain the data that is currently in the cloud. The missing parts can be found in the field: detailedState.intervals.missingIntervals.

period
object
required

Period for which to make the export of. The duration can't exceed 8 hours. If endTimestamp is not given, the current time will be used.

osd
object

If included the timestamp of each frame is super imposed in the export.

info
object
required
integer
required
1 to 48

Playback multiplier used to create the time lapse video

Responses

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago