Creates a new job that uses AI to generate a title, description, and tags for a Mux Video asset. Optional output steering can guide summary style, audience, brand terms, and tag taxonomy without changing the response schema.
Arbitrary string stored with the job and returned in responses. Useful for correlating jobs with your own systems.
The Mux asset ID of the video to summarize.
Tone for the generated summary. "neutral" for straightforward analysis, "playful" for witty and conversational, "professional" for executive-level reporting.
Curated output_steering controls for summary style, audience, brand terminology, and tag taxonomy. These controls guide model behavior but do not guarantee exact output.
Controlled vocabulary for tag generation. This steers tags and may be deterministically filtered after generation. Supports up to 50 values and 2000 serialized characters.
Optional customer-facing name for the taxonomy, up to 100 characters.
Controlled vocabulary values for generated tags. Supports 1-50 values.
Canonical tag value to prefer in generated tags, up to 100 characters.
Short explanation of when this tag applies, up to 300 characters.
Accepted alternate names that should normalize to the canonical label. Up to 10 aliases, each up to 100 characters.
When false, generated tags are filtered to taxonomy labels and aliases. When true, unmatched tags may remain.
Best-effort style guidance for the generated title and description.
Intended audience used as best-effort model guidance. Does not change the output schema.
Preferred brand or domain terms to use when supported by the source content.
Legacy/internal prompt-section overrides. Prefer output_steering for new integrations.
Override the core task instruction for summarization.
Override the title generation requirements.
Override the description generation requirements.
Override the keyword/tag extraction requirements.
Override the quality standards for analysis.
Maximum title length in words.
Maximum description length in words.
Maximum number of tags to include in the generated output. Defaults to 10.
BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When omitted, the SDK uses the default track.
BCP 47 language code for the generated summary output (e.g. "en", "fr", "ja"). Auto-detected from the transcript if omitted.
{
"parameters": {
"asset_id": "mux_asset_123abc",
"tone": "neutral",
"tag_count": 10,
"output_steering": {
"summary_style": "concise",
"audience": "Product marketers",
"brand_terms": [
"Mux",
"Robots"
]
}
}
}{
"data": {
"id": "rjob_example123",
"workflow": "summarize",
"status": "pending",
"units_consumed": 0,
"created_at": 1700000000,
"updated_at": 1700000060,
"parameters": {
"asset_id": "mux_asset_123abc",
"tone": "neutral",
"tag_count": 10,
"output_steering": {
"summary_style": "concise",
"audience": "Product marketers",
"brand_terms": [
"Mux",
"Robots"
]
}
}
}
}