Skip to Content
Create a 'find-key-moments' job
post

Creates a new job that uses AI to identify key moments in a Mux Video asset.

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.

post
202
/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
    }
  }
}
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
      }
    }
  }
}