Skip to Content
Create a 'summarize' job
post

Creates a new job that uses AI to generate a title, description, and tags for 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 summarize.

parameters.tone
string
Possible values: "neutral""playful""professional"

Tone for the generated summary. "neutral" for straightforward analysis, "playful" for witty and conversational, "professional" for executive-level reporting.

Override specific sections of the summarization prompt.

parameters.prompt_overrides.task
string

Override the core task instruction for summarization.

parameters.prompt_overrides.title
string

Override the title generation requirements.

parameters.prompt_overrides.description
string

Override the description generation requirements.

parameters.prompt_overrides.keywords
string

Override the keyword/tag extraction requirements.

parameters.prompt_overrides.quality_guidelines
string

Override the quality standards for analysis.

parameters.title_length
integer
(min: 1)

Maximum title length in words.

parameters.description_length
integer
(min: 1)

Maximum description length in words.

parameters.tag_count
integer
(min: 1)

Maximum number of tags to include in the generated output. Defaults to 10.

parameters.language_code
string

BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When omitted, the SDK uses the default track.

parameters.output_language_code
string

BCP 47 language code for the generated summary output (e.g. "en", "fr", "ja"). Auto-detected from the transcript if omitted.

post
202
/robots/v0/jobs/summarize
Request
(application/json)
{
  "parameters": {
    "asset_id": "mux_asset_123abc",
    "tone": "neutral",
    "tag_count": 10
  }
}
Response
(application/json)
{
  "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
    }
  }
}