Asset Metadata

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cesium/main/json-schema/cesium-asset-metadata-schema.json",
  "title": "Asset Metadata",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/cesium-api-openapi.yml#/components/schemas/AssetMetadata",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/AssetIdentifier"
    },
    "name": {
      "$ref": "#/$defs/AssetName"
    },
    "description": {
      "$ref": "#/$defs/AssetDescription"
    },
    "attribution": {
      "$ref": "#/$defs/AssetAttribution"
    },
    "type": {
      "$ref": "#/$defs/AssetType"
    },
    "bytes": {
      "description": "The number of bytes this asset occupies in the user's account.",
      "type": "integer",
      "minimum": 0,
      "readOnly": true
    },
    "dateAdded": {
      "description": "The date and time that this asset was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format.",
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "status": {
      "$ref": "#/$defs/AssetStatus"
    },
    "percentComplete": {
      "type": "integer",
      "description": "The percentage progress of the tiling pipeline preparing this asset.",
      "minimum": 0,
      "maximum": 100,
      "readOnly": true
    },
    "archivable": {
      "type": "boolean",
      "description": "If true the asset can be archived else if false the asset cannot be archived.",
      "readOnly": true
    },
    "exportable": {
      "type": "boolean",
      "description": "`true` if this asset can be used with the exports API, `false` otherwise.\n",
      "readOnly": true
    },
    "labels": {
      "type": "array",
      "description": "The labels currently applied to this asset.",
      "items": {
        "$ref": "#/$defs/LabelMetadata"
      },
      "readOnly": true
    },
    "options": {
      "$ref": "#/$defs/AssetOptions"
    },
    "from": {
      "$ref": "#/$defs/AssetFrom"
    },
    "creatorId": {
      "type": "integer",
      "description": "The userId of the user that created this asset; `undefined` for premium assets",
      "readOnly": true
    },
    "creatorUsername": {
      "type": "string",
      "description": "The username of the user that created this asset, `undefined` for premium assets, or if the user has been deleted",
      "readOnly": true
    }
  },
  "required": [
    "name",
    "type",
    "options"
  ],
  "$defs": {
    "AssetAttribution": {
      "type": "string",
      "description": "A Markdown compatible string containing any required attribution for this asset. Clients will be required to display this attribution to end users."
    },
    "AssetDescription": {
      "type": "string",
      "description": "A Markdown string describing this asset."
    },
    "AssetFrom": {
      "description": "When supplied, contains options for tiling source files hosted by external services. When using AWS S3, the size of the resulting tileset, not the size of the source data, is counted against your account storage quota.",
      "writeOnly": true,
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "S3",
            "AZURE",
            "SKETCHFAB"
          ],
          "description": "Specifies the type of external service. Currently only Amazon S3, Azure and Sketchfab are supported. To import from Sketchfab, you must link your Sketchfab account to your ion account on your [user account page](https://ion.cesium.com/account) and specify `options.sourceType` as `3D_MODEL` or `3D_CAPTURE`."
        }
      },
      "required": [
        "type"
      ]
    },
    "AssetIdentifier": {
      "type": "integer",
      "description": "The unique identifier for this asset."
    },
    "AssetName": {
      "type": "string",
      "description": "The name of this asset."
    },
    "AssetOptions": {
      "description": "Contains options specific to the type of source data being uploaded.",
      "writeOnly": true,
      "properties": {
        "sourceType": {
          "type": "string",
          "description": "The type of data being uploaded.\n\n| Value | Description |\n| - | - |\n| RASTER_IMAGERY | Imagery data in any [supported raster format](https://cesium.com/learn/3d-tiling/tiler-data-formats/#supported-data-formats) |\n| RASTER_TERRAIN | Terrain data as a single a single band of floating point or integer elevations in any [supported raster format](https://cesium.com/learn/3d-tiling/tiler-data-formats/#supported-data-formats) |\n| TERRAIN_DATABASE | A single Cesium Terrain Database file |\n| CITYGML | CityGML with associated textures |\n| KML | KML or KMZ file with associated COLLADA models and textures |\n| 3D_CAPTURE | An OBJ, COLLADA, or glTF model created through photogrammetry processes |\n| BIM_CAD | An IFC, OBJ or glTF model created through a BIM/CAD design process |\n| BIM_CAD_DB | A design model in IFC, Revit, DWG, DXF or DGN formats. |\n| 3D_MODEL | An OBJ, COLLADA, or glTF model created through 3D scanning processes |\n| POINT_CLOUD | A LASer or LAZ point cloud. A PLY file for gaussian splats |\n| 3DTILES | A pre-tiled 3D Tiles tileset |\n| CZML | A CZML file with associated models and textures |\n| GEOJSON | A GeoJSON files. |\n\nSelect a value from the list to see options specific to the selected type. Not all types provide additional options.\n"
        }
      },
      "required": [
        "sourceType"
      ]
    },
    "AssetStatus": {
      "type": "string",
      "enum": [
        "AWAITING_FILES",
        "NOT_STARTED",
        "IN_PROGRESS",
        "COMPLETE",
        "ERROR",
        "DATA_ERROR"
      ],
      "description": "Describes the state of the asset during the upload and tiling processes:\n\n| Value | Description |\n| - | - |\n| AWAITING_FILES | The asset has been created but the server is waiting for source data to be uploaded. |\n| NOT_STARTED | The server was notified that all source data was uploaded and is waiting for the tiling process to start. |\n| IN_PROGRESS | The source data is being tiled, see `percentComplete` to monitor progress. |\n| COMPLETE | The asset was tiled successfully. |\n| DATA_ERROR | The uploaded source data was invalid or unsupported. |\n| ERROR | An internal error occurred during the tiling process. Please contact support@cesium.com. |\n",
      "readOnly": true
    },
    "AssetType": {
      "type": "string",
      "enum": [
        "3DTILES",
        "GLTF",
        "IMAGERY",
        "TERRAIN",
        "KML",
        "CZML",
        "GEOJSON"
      ],
      "description": "This asset's [type](#tag/Assets)."
    },
    "LabelIdentifier": {
      "type": "integer",
      "description": "The unique identifier for this label."
    },
    "LabelMetadata": {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/LabelIdentifier"
        },
        "name": {
          "$ref": "#/$defs/LabelName"
        },
        "color": {
          "$ref": "#/$defs/LabelResponseColor"
        }
      },
      "required": [
        "id",
        "name",
        "color"
      ]
    },
    "LabelName": {
      "type": "string",
      "description": "The name of this label."
    },
    "LabelResponseColor": {
      "type": "string",
      "description": "The label color encoded as a CSS hex string."
    }
  }
}