Skip to Content
Mux Docs: Home
Create a 'find-key-moments' job
post

Creates a new job that uses AI to identify key moments in a Mux Video asset. Optional output steering can guide selection strategy, title style, audience, topic taxonomy, and scoring priorities without changing the response schema.

Request body params
passthrough
string

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

parameters.asset_id
string

The Mux asset ID of the video to analyze.

parameters.max_moments
integer
(min: 1, max: 10)

Maximum number of key moments to extract. Defaults to 5.

Preferred highlight duration range in milliseconds. When provided, the model will aim to select moments within this range.

parameters.target_duration_ms.min
integer

Preferred minimum highlight duration in milliseconds.

parameters.target_duration_ms.max
integer

Preferred maximum highlight duration in milliseconds.

Curated output_steering controls for selection strategy, title style, audience, taxonomy, and rubric tie-breakers. These controls guide model behavior but do not guarantee exact output.

parameters.output_steering.selection_strategy
string
Possible values: "standalone_hooks""educational_takeaways""story_beats""product_moments""speaker_highlights"

Best-effort guidance for what qualifies as a strong standalone key moment.

parameters.output_steering.title_style
string
Possible values: "descriptive""punchy""educational""social"

Best-effort title style guidance for generated moment titles.

parameters.output_steering.audience
string

Intended audience used as best-effort model guidance. Does not change the output schema.

parameters.output_steering.brand_terms
array

Preferred brand or domain terms to use when supported by the source content.

parameters.output_steering.topic_taxonomy
parameters.output_steering.rubric_priorities
array

Rubric dimensions to use as tie-breakers after applying selection strategy. Best-effort guidance only.

Possible values: "clarity_in_isolation""emotional_intensity""novelty""soundbite_quality"
post
202
https://api.mux.com/robots/v0/jobs/find-key-moments
Request
(application/json)
{
  "parameters": {
    "asset_id": "mux_asset_123abc",
    "max_moments": 5,
    "target_duration_ms": {
      "min": 15000,
      "max": 45000
    },
    "output_steering": {
      "selection_strategy": "educational_takeaways",
      "title_style": "punchy",
      "audience": "Developer advocates",
      "rubric_priorities": [
        "clarity_in_isolation",
        "soundbite_quality"
      ]
    }
  }
}
Response
(application/json)
{
  "data": {
    "id": "rjob_example123",
    "workflow": "find-key-moments",
    "status": "pending",
    "units_consumed": 0,
    "created_at": 1700000000,
    "updated_at": 1700000060,
    "parameters": {
      "asset_id": "mux_asset_123abc",
      "max_moments": 5,
      "target_duration_ms": {
        "min": 15000,
        "max": 45000
      },
      "output_steering": {
        "selection_strategy": "educational_takeaways",
        "title_style": "punchy",
        "audience": "Developer advocates",
        "rubric_priorities": [
          "clarity_in_isolation",
          "soundbite_quality"
        ]
      }
    }
  }
}