VideoMomentFrameDto

Endpoints · All schemas

Field	Required	Description
frameIndex	Yes	integer
height	Yes	integer
id	Yes	string
indexed	Yes	Has a search embedding from the saved search model
isCover	Yes	boolean
rank	Yes	1 is the best frame
score	Yes	number
timestampMs	Yes	integer
width	Yes	integer

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "frameIndex": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "height": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    },
    "id": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "indexed": {
      "description": "Has a search embedding from the saved search model",
      "type": "boolean"
    },
    "isCover": {
      "type": "boolean"
    },
    "rank": {
      "description": "1 is the best frame",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "score": {
      "format": "double",
      "type": "number"
    },
    "timestampMs": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "width": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    }
  },
  "required": [
    "frameIndex",
    "height",
    "id",
    "indexed",
    "isCover",
    "rank",
    "score",
    "timestampMs",
    "width"
  ],
  "type": "object"
}