Skip to Content
Create a 'generate-chapters' job
post

Creates a new job that uses AI to generate chapters 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 generate chapters for.

parameters.language_code
string

BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When omitted, the SDK prefers English if available.

parameters.output_language_code
string

BCP 47 language code for the output chapter titles. Auto-detected from the transcript if omitted.

Override specific sections of the chapter generation prompt.

parameters.prompt_overrides.task
string

Override the core task instruction for chapter generation.

parameters.prompt_overrides.output_format
string

Override the JSON output format instructions.

parameters.prompt_overrides.chapter_guidelines
string

Override the chapter density and timing constraints.

parameters.prompt_overrides.title_guidelines
string

Override the chapter title style requirements.

post
202
/robots/v0/jobs/generate-chapters
Request
(application/json)
{
  "parameters": {
    "asset_id": "mux_asset_123abc"
  }
}
Response
(application/json)
{
  "data": {
    "id": "rjob_example123",
    "workflow": "generate-chapters",
    "status": "pending",
    "units_consumed": 0,
    "created_at": 1700000000,
    "updated_at": 1700000060,
    "parameters": {
      "asset_id": "mux_asset_123abc"
    }
  }
}