Skip to content

StudioRestoredVersionDto

Endpoints · All schemas

FieldRequiredDescription
assetIdYesThe library original it was made from; never replaced by it
availableYesWhether it can be placed and rendered now
durationSecondsYesLength of a video, in seconds
expiresAtYesWhen the result will be removed, when it has a retention date
heightYesPixel height of the restored file
mediaIdYesThe media id a clip of this version carries: `restored-<restorationId>`
modeYesSee definition below
originalFileNameYesThe original’s file name, for the bin label
restorationIdYesThe restoration
restoredAtYesWhen the full result finished
smoothMotionFactorYesFrame-rate factor of a Smooth motion version
sourceTypeYesSee definition below
unavailableYesSee definition below
upscaleYesUpscale factor of a restoration; 1 for Smooth motion
widthYesPixel width of the restored file

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.

Field definitions: AssetRestorationMode, AssetRestorationSourceType, StudioRestoredVersionUnavailable

{
  "properties": {
    "assetId": {
      "description": "The library original it was made from; never replaced by it",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "available": {
      "description": "Whether it can be placed and rendered now",
      "type": "boolean"
    },
    "durationSeconds": {
      "description": "Length of a video, in seconds",
      "format": "double",
      "nullable": true,
      "type": "number"
    },
    "expiresAt": {
      "description": "When the result will be removed, when it has a retention date",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "height": {
      "description": "Pixel height of the restored file",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    },
    "mediaId": {
      "description": "The media id a clip of this version carries: `restored-<restorationId>`",
      "type": "string"
    },
    "mode": {
      "$ref": "#/components/schemas/AssetRestorationMode"
    },
    "originalFileName": {
      "description": "The original’s file name, for the bin label",
      "type": "string"
    },
    "restorationId": {
      "description": "The restoration",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "restoredAt": {
      "description": "When the full result finished",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "smoothMotionFactor": {
      "description": "Frame-rate factor of a Smooth motion version",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    },
    "sourceType": {
      "$ref": "#/components/schemas/AssetRestorationSourceType"
    },
    "unavailable": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StudioRestoredVersionUnavailable"
        }
      ],
      "nullable": true
    },
    "upscale": {
      "description": "Upscale factor of a restoration; 1 for Smooth motion",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "width": {
      "description": "Pixel width of the restored file",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "nullable": true,
      "type": "integer"
    }
  },
  "required": [
    "assetId",
    "available",
    "durationSeconds",
    "expiresAt",
    "height",
    "mediaId",
    "mode",
    "originalFileName",
    "restorationId",
    "restoredAt",
    "smoothMotionFactor",
    "sourceType",
    "unavailable",
    "upscale",
    "width"
  ],
  "type": "object"
}