Create a 'find-key-moments' job
Changed onDeprecated: use POST /robots/v1/jobs/find-key-moments instead. 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.
Request
- Base URLhttps://api.mux.com
- Auth
- HTTP basic
- or HTTP bearer
Request body
Example request
{
"parameters": {
"asset_id": "mux_asset_123abc",
"max_moments": 10,
"target_duration_ms": {
"min": 15000,
"max": 45000
},
"output_steering": {
"scope": {
"start_time": 30,
"end_time": 180
},
"selection_strategy": "educational_takeaways",
"title_style": "punchy",
"audience": "Developer advocates",
"rubric_priorities": [
"clarity_in_isolation",
"soundbite_quality"
]
}
}
}Response
Key moments job queued
Example response
{
"data": {
"parameters": {
"asset_id": "mux_asset_123abc",
"max_moments": 10,
"target_duration_ms": {
"min": 15000,
"max": 45000
},
"output_steering": {
"scope": {
"start_time": 30,
"end_time": 180
},
"selection_strategy": "educational_takeaways",
"title_style": "punchy",
"audience": "Developer advocates",
"rubric_priorities": [
"clarity_in_isolation",
"soundbite_quality"
]
}
},
"resources": {
"assets": [
{
"id": "abc123asset",
"meta": {
"title": "My Video",
"creator_id": "user123",
"external_id": "ext456"
},
"_links": {
"self": {
"href": "/video/v1/assets/abc123asset"
}
}
}
]
},
"outputs": {
"moments": [
{
"start_ms": 15000,
"end_ms": 45000,
"cues": [
{
"start_ms": 15000,
"end_ms": 20000,
"text": "This is the moment everything changed."
},
{
"start_ms": 20000,
"end_ms": 30000,
"text": "We realized the entire approach was wrong."
}
],
"overall_score": 0.92,
"title": "The Pivotal Realization",
"quotable_segment": {
"start_ms": 20000,
"text": "We realized the entire approach was wrong."
},
"audible_narrative": "The speaker describes the turning point that reshaped the project direction.",
"notable_audible_concepts": [
"pivotal realization moment",
"project direction change"
],
"visual_narrative": "The speaker gestures emphatically at a whiteboard diagram while the camera zooms in.",
"notable_visual_concepts": [
{
"concept": "whiteboard diagram emphasis",
"score": 0.88,
"rationale": "The diagram directly illustrates the pivotal realization being described."
},
{
"concept": "speaker emphatic gestures",
"score": 0.75,
"rationale": "Body language reinforces the emotional weight of the turning point."
}
]
}
]
}
}
}Changes
- info
endpoint deprecated
- info
- breaking
added to the
//request propertyallOflist - breaking
added to the
//request propertyallOflist - warning
removed from the
//request propertyallOflist - warning
removed from the
//request propertyallOflist - info
api operation id
create-find-key-moments-jobremoved and replaced withcreate-find-key-moments-job-v0 - info
api tag
Find Key Moments (v0)added - info
api tag
Find Key Momentsremoved - info
added to the
///response propertyallOflist for the response status - info
added to the
///response propertyallOflist for the response status - info
removed from the
///response propertyallOflist for the response status - info
removed from the
///response propertyallOflist for the response status
- breaking