Add metadata to a live stream

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:

1
"metadata": { 
2
  "event": "product_launch", 
3
  "region": "EU" 
4
} 

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

Before you can add metadata to a livestream, you must first create a stream with the FastPix API. To see the full definition of this endpoint, request parameters, and example responses, refer to the Create new stream API.

Using API (during stream creation)

You can update the livestream’s metadata using the Update live stream endpoint. For complete details on all supported fields and response formats, refer to the Update live stream API.

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

1
{
2
  "playbackSettings": {
3
    "accessPolicy": "public"
4
  },
5
  "inputMediaSettings": {
6
    "maxResolution": "1080p",
7
    "reconnectWindow": 60,
8
    "mediaPolicy": "public",
9
    "metadata": {
10
      "livestream_name": "fastpix_livestream"
11
    }
12
  }
13
}

Add metadata using the dashboard

You can add metadata to a livestream directly from the FastPix Dashboard during or after stream creation. This is useful for tagging streams with names, IDs, or contextual information that downstream workflows and analytics can use.

1. Open the FastPix dashboard.

2. Go to Products > Live Streams.

3. Click Create live stream.

In the creation form:

1. Enter a Stream name (optional but recommended).

2. Configure stream settings such as resolution, reconnect window, and access policy.

3. Click Run Request.

At this point, FastPix generates your stream details, including the stream key and playback IDs.

1
"metadata": { 
2
  "livestream_name": "fastpix_livestream" 
3
} 

Update your livestream metadata

Use this API to update metadata:

https://api.fastpix.com/v1/live/streams/{streamId}

Example:

1
{ 
2
  "metadata": { 
3
    "moderated": "true", 
4
    "language": "fr" 
5
  } 
6
}

📘 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