Skip to content

AssetMediaCreateDto

Endpoints · All schemas

FieldRequiredDescription
assetDataYesAsset file data
durationNoDuration in milliseconds (for videos)
fileCreatedAtYesFile creation date
fileModifiedAtYesFile modification date
filenameNoFilename
isFavoriteNoMark as favorite
livePhotoVideoIdNoLive photo video ID
metadataNoAsset metadata items
sidecarDataNoSidecar file data
visibilityNoSee definition below

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: AssetMetadataUpsertItemDto, AssetVisibility

{
  "properties": {
    "assetData": {
      "description": "Asset file data",
      "format": "binary",
      "type": "string"
    },
    "duration": {
      "description": "Duration in milliseconds (for videos)",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "fileCreatedAt": {
      "description": "File creation date",
      "example": "2024-01-01T00:00:00.000Z",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "type": "string"
    },
    "fileModifiedAt": {
      "description": "File modification date",
      "example": "2024-01-01T00:00:00.000Z",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "type": "string"
    },
    "filename": {
      "description": "Filename",
      "type": "string"
    },
    "isFavorite": {
      "description": "Mark as favorite",
      "type": "boolean"
    },
    "livePhotoVideoId": {
      "description": "Live photo video ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "metadata": {
      "description": "Asset metadata items",
      "items": {
        "$ref": "#/components/schemas/AssetMetadataUpsertItemDto"
      },
      "type": "array"
    },
    "sidecarData": {
      "description": "Sidecar file data",
      "format": "binary",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/components/schemas/AssetVisibility"
    }
  },
  "required": [
    "assetData",
    "fileCreatedAt",
    "fileModifiedAt"
  ],
  "type": "object"
}