Add metadata to livestream

FastPix lets you attach metadata to any livestream at the time of creation. This metadata can be used to label the stream, organize dashboards, or trigger automations in your systems.

What is livestream metadata?

Metadata for livestreams is a simple JSON object attached during stream creation. It stays with the stream and any recorded archive, making it useful for classification and integration.

Example:

"metadata": { 
  "event": "product_launch", 
  "region": "EU" 
} 

Why add metadata to livestreams?

• Track livestreams by region, event, or host
• Integrate with your internal scheduling or analytics tools
• Trigger overlays, banners, or AI functions
• Improve archival sorting and discoverability
• Store ownership or moderation flags

Schema rules

Similar rules as VOD:

• Flat JSON only (no nested objects or arrays)
• Keys: lowercase strings recommended
• Values: strings or numbers
• Max: 10 key-value pairs per stream

How to add metadata

With API (during stream creation)

Include your metadata inside the inputMediaSettings object when creating a new livestream.

{ 
  "playbackSettings": { 
    "accessPolicy": "public" 
  }, 
  "inputMediaSettings": { 
    "maxResolution": "1080p", 
    "reconnectWindow": 60, 
    "metadata": { 
      "livestream_name": "demo_day", 
      "track": "2025_q4_events" 
    } 
  } 
} 

With dashboard

• Go to create livestream
• Fill in settings
• Scroll to metadata
• Add key-value pairs (up to 10)

"metadata": { 
  "livestream_name": "fastpix_livestream" 
} 

Update your livestream metadata

Use this API to update metadata:

https://v1.fastpix.io/live/streams/{streamId}

Example:

{ 
  "metadata": { 
    "moderated": "true", 
    "language": "fr" 
  } 
}

📘

PLEASE NOTE

• No partial updates: This is a replace-only operation. Fields not included in the request will be deleted.
• Schema rules apply: Keys must be strings; values must be strings or numbers. No nesting or arrays allowed.
• Max 10 pairs: If you send more than 10 fields, the extra ones will be silently dropped.

Example use cases