MUmuxinc
Generate Engagement Insights

Create a 'generate-engagement-insights' job

Changed on

Creates a new job that uses AI to analyze viewer engagement patterns and generate insights for a Mux Video asset. Uses the first ready subtitle in asset track order without English preference. Audio-only assets with one ready text track lacking subtitle metadata can use that legacy transcript. Caption evidence is optional, including for audio-only assets without captions.

post/robots/v1/jobs/generate-engagement-insights

Request

  • Base URL
    https://api.mux.com
  • Auth
    • HTTP basic
    • or HTTP bearer

Request body

passthroughstring

Arbitrary string stored with the job and returned in responses. Useful for correlating jobs with your own systems.

Example request

{
  "parameters": {
    "asset_id": "mux_asset_123abc"
  }
}

Response

Engagement insights job queued

Example response

{
  "data": {
    "parameters": {
      "asset_id": "mux_asset_123abc"
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "moment_insights": [
        {
          "start_time": 30.123,
          "end_time": 60.456,
          "engagement_score": 0.89,
          "insight": "High engagement during the demo."
        }
      ],
      "overall_insight": {
        "summary": "Engagement peaks during demonstrations.",
        "trends": [
          "Product demos drive retention"
        ]
      }
    }
  }
}

Changes