ADT · Schema

VideoClip

A recorded video clip from a security camera.

Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Properties

Name Type Description
id string Unique identifier of the video clip.
cameraId string ID of the camera that recorded the clip.
startTime string Start timestamp of the recording.
endTime string End timestamp of the recording.
trigger string What triggered the recording.
downloadUrl string Pre-signed URL to download the video clip.
thumbnailUrl string URL of the clip thumbnail image.
View JSON Schema on GitHub

JSON Schema

platform-api-video-clip-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-schema/platform-api-video-clip-schema.json",
  "title": "VideoClip",
  "description": "A recorded video clip from a security camera.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the video clip.",
      "example": "clip-001"
    },
    "cameraId": {
      "type": "string",
      "description": "ID of the camera that recorded the clip.",
      "example": "dev-cam-001"
    },
    "startTime": {
      "type": "string",
      "format": "date-time",
      "description": "Start timestamp of the recording.",
      "example": "2025-03-15T14:30:00Z"
    },
    "endTime": {
      "type": "string",
      "format": "date-time",
      "description": "End timestamp of the recording.",
      "example": "2025-03-15T14:31:00Z"
    },
    "trigger": {
      "type": "string",
      "description": "What triggered the recording.",
      "enum": [
        "motion",
        "alarm",
        "manual",
        "schedule"
      ],
      "example": "motion"
    },
    "downloadUrl": {
      "type": "string",
      "format": "uri",
      "description": "Pre-signed URL to download the video clip.",
      "example": "https://media.adt.com/clips/clip-001.mp4"
    },
    "thumbnailUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL of the clip thumbnail image.",
      "example": "https://media.adt.com/thumbnails/clip-001.jpg"
    }
  }
}