MUmuxinc
Find Key Moments

Create a 'find-key-moments' job

Changed on

Creates a new job that uses AI to identify key moments in a Mux Video asset. Set use_shots to true to automatically generate or reuse Mux shots and use visual evidence during selection, with transcript evidence incorporated when available; otherwise selection uses transcript evidence and the asset must have a caption track. Audio-only assets always use transcript evidence and require a caption track. Optional output steering can restrict execution to a time scope in seconds and guide selection strategy, title style, audience, topic taxonomy, and scoring priorities without changing the response schema. Scoped results retain absolute timestamps on the original asset timeline. 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. Audio-only analysis requires a caption source; video analysis can proceed without automatic captions when the selected mode permits it.

post/robots/v1/jobs/find-key-moments

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",
    "max_moments": 10,
    "target_duration": {
      "min": 15.123,
      "max": 45.456
    }
  }
}

Response

Key moments job queued

Example response

{
  "data": {
    "parameters": {
      "asset_id": "mux_asset_123abc",
      "max_moments": 10,
      "target_duration": {
        "min": 15.123,
        "max": 45.456
      }
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "moments": [
        {
          "start_time": 15.123,
          "end_time": 45.456,
          "cues": [
            {
              "start_time": 15.123,
              "end_time": 23.456,
              "text": "This is the moment everything changed."
            }
          ],
          "overall_score": 0.92,
          "title": "The Pivotal Realization",
          "quotable_segment": {
            "time": 15.123,
            "text": "This is the moment everything changed."
          },
          "audible_narrative": "The speaker describes a turning point.",
          "notable_audible_concepts": [
            "pivotal realization moment"
          ]
        }
      ]
    }
  }
}

Changes