Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.metabind.ai/llms.txt

Use this file to discover all available pages before exploring further.

Assets represent media files (images, videos, documents, etc.) stored on the CDN and managed through Metabind. Assets referenced by Packages are preserved to maintain package integrity.

​
Key Concepts

Package Integration

Assets referenced by packages are immutable. Package references prevent deletion, and new versions can be created while maintaining package integrity.

Status Management

Assets can be active or deleted. Deletion is prevented if referenced. Soft-delete preserves history.

CDN Integration

All assets are served through CDN with versioned URLs, cache control headers, and geographic distribution.

Optimization

On-demand transformations including format conversion, size optimization, and quality adjustments.

​
Asset Object

The Asset object contains all metadata and references for a media file.

​
Fields

FieldTypeDescription
idstringUnique identifier (UUID)
namestringDisplay name
descriptionstringStructured markdown description for semantic search
typestringMIME type (e.g., image/jpeg, video/mp4)
urlstringCDN URL
statusstringStatus: active or deleted
sizenumberFile size in bytes
tagsstring[]Asset categories
createdAtstringCreation timestamp (ISO format)
updatedAtstringLast update timestamp (ISO format)

​
Metadata Object

FieldTypeDescription
metadata.widthnumberImage width in pixels (if applicable)
metadata.heightnumberImage height in pixels (if applicable)
metadata.durationnumberMedia duration in seconds (if applicable)
metadata.formatstringFile format
metadata.usage.componentsstring[]Components referencing this asset
metadata.usage.packagesstring[]Packages containing this asset
metadata.usage.contentstring[]Content items using this asset

​
Example

{
  "id": "asset123",
  "name": "hero-image.jpg",
  "description": "Hero banner image for homepage header. High-resolution landscape image showcasing product features.\n\n**Usage:** Homepage hero section, marketing campaigns\n**Dimensions:** 1920x1080\n**Format:** JPEG (optimized for web)\n**Subject:** Product showcase with lifestyle elements",
  "type": "image/jpeg",
  "status": "active",
  "url": "https://cdn.metabind.ai/images/hero-image.jpg",
  "size": 2048576,
  "metadata": {
    "width": 1920,
    "height": 1080,
    "format": "jpeg",
    "usage": {
      "components": ["comp123"],
      "packages": ["1.0.0", "1.1.0"],
      "content": ["cont123"]
    }
  },
  "tags": ["hero", "article"],
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:00:00Z"
}

​
Description Field Standards

The asset description field follows a structured markdown format optimized for semantic search and LLM understanding.

​
Template

[Brief description of the asset]. [Additional context about usage or content].

**Usage:** [Where/how this asset is typically used]
**Dimensions:** [Width x Height for images]
**Duration:** [Length for video/audio]
**Format:** [File format and optimization details]
**Subject:** [What the asset depicts or contains]
Aim for 200-300 characters. Maximum 400 characters.

​
Examples

Hero banner image for homepage header. High-resolution landscape image showcasing product features.

**Usage:** Homepage hero section, marketing campaigns
**Dimensions:** 1920x1080
**Format:** JPEG (optimized for web)
**Subject:** Product showcase with lifestyle elements