--- title: "Get a 'generate-chapters' job" method: GET path: "/robots/v0/jobs/generate-chapters/{JOB_ID}" tags: ["Generate Chapters (v0)"] deprecated: true --- # Get a 'generate-chapters' job `GET /robots/v0/jobs/generate-chapters/{JOB_ID}` ## Request - Base URL: `https://api.mux.com` - URL: `https://api.mux.com/robots/v0/jobs/generate-chapters/{JOB_ID}` - Auth: one of: - HTTP basic - HTTP bearer > **Deprecated.** Deprecated: use `GET /robots/v1/jobs/generate-chapters/{job_id}` instead. Retrieves the current status and results of a 'generate-chapters' job. Jobs are automatically deleted after 30 days. ## Path parameters - `JOB_ID` string, required: Robots job ID returned by job creation or listing (rjob_...). ## Response `200` Current status for the requested job - GenerateChaptersJobResponseV0 - `data` GenerateChaptersJobV0, required - `id` string, required: Unique job identifier. - `passthrough` string: Arbitrary string supplied at creation, returned as-is. - `units_consumed` integer, required: Number of Mux AI units consumed by this job. - `directive` JobDirectiveContextV0: The directive run that dispatched this job. Absent for jobs created via direct API POST. - `id` string, required: ID of the directive that dispatched this job. - `run_id` string, required: ID of the specific directive run that dispatched this job. - `created_at` integer, required: Unix timestamp (seconds) when the job was created. - `updated_at` integer, required: Unix timestamp (seconds) of the job's last state transition (e.g. when it started processing or reached a terminal state). - `workflow` 'generate-chapters', required - `parameters` GenerateChaptersJobParametersV0, required - `asset_id` string, required: The Mux asset ID of the video to generate chapters for. - `language_code` string: BCP 47 language code of the caption track to analyze (e.g. "en", "fr"). When omitted, the first ready text track on the asset is selected. - `output_language_code` string: BCP 47 language code for the output chapter titles. Auto-detected from the transcript if omitted. - `output_steering` GenerateChaptersOutputSteeringV0: Curated output_steering controls for chapter style, granularity, audience, and brand terminology. These controls guide model behavior but do not guarantee exact output. - `chapter_style` 'descriptive' | 'punchy' | 'educational' | 'seo' | 'platform_neutral': Best-effort style guidance for generated chapter titles. - `chapter_granularity` 'coarse' | 'balanced' | 'fine': Best-effort guidance for how coarse or fine chapter boundaries should be. - `audience` string: Intended audience used as best-effort model guidance. Does not change the output schema. - `brand_terms` string[]: Preferred brand or domain terms to use when supported by the source content. - `prompt_overrides` object: Deprecated: use `output_steering`. Raw prompt-section overrides; any section supplied here takes precedence over the equivalent `output_steering` guidance. - `task` string: Override the core task instruction for chapter generation. - `output_format` string: Override the JSON output format instructions. - `chapter_guidelines` string: Override the chapter density and timing constraints. - `title_guidelines` string: Override the chapter title style requirements. - `update_asset_chapters` boolean: When true, the generated chapters are written back to the Mux asset as a chapters text track once the job completes, making them deliverable with the asset. Overwrites existing chapters: an asset holds a single chapters track, so any chapters track already on the asset is deleted and replaced — including one in a different language, and one you created yourself. Best-effort — a failed write does not fail the job — so check `asset_updates.chapters` in the job outputs for the outcome. - `status` 'pending' | 'processing' | 'completed' | 'errored' | 'cancelled', required: Current job status. - `errors` JobErrorV0[]: Error details. Present when status is 'errored'. - `type` string, required: Stable public error category identifier. - `message` string, required: Human-readable public error message. - `retryable` boolean: Whether retrying this job may resolve the error. - `resources` ResourcesV0: Related Mux resources linked to this job. - `assets` SlimlineAssetV0[], required: Mux assets associated with this job. - `id` string, required: Mux asset ID. - `meta` object: Mux asset metadata, if available. - `title` string: Asset title from Mux metadata. - `creator_id` string: Creator identifier from Mux metadata. - `external_id` string: External identifier from Mux metadata. - `passthrough` string: Passthrough string from the Mux asset. - `_links` object, required: Hypermedia links for the asset. - `self` object, required - `href` string, required: URL to the Mux asset resource. - `outputs` GenerateChaptersJobOutputsV0: Workflow results. Present when status is 'completed'. - `chapters` object[], required: Generated chapters, ordered by start time. - `start_time` number, required: Chapter start time in seconds. The first chapter always starts at 0. - `title` string, required: Concise chapter title. - `asset_update` GenerateChaptersLegacyAssetUpdateV0: Deprecated: use `asset_updates.chapters` instead. - `status` 'created' | 'failed', required: Outcome of the chapters track write. `created` means the asset now carries these chapters. `failed` means the write was attempted and errored; the chapters in this response are still valid and can be applied manually. - `track_id` string: Mux text track ID of the chapters track created on the asset. Present when status is `created`. - `replaced_track_id` string: Mux text track ID of the chapters track that was deleted to make room for the new one. Absent when the asset had no chapters track. On a `failed` status it means the delete succeeded but the create did not, leaving the asset with no chapters track. - `asset_updates` GenerateChaptersAssetUpdateOutcomesV0: Recorded chapters track update outcome. Omitted when no outcome was recorded. - `chapters` GenerateChaptersAssetUpdateV0: What happened when the generated chapters were written back to the Mux asset. Present only when update_asset_chapters was true. - `status` 'created' | 'failed', required: Outcome of the chapters track write. `created` means the asset now carries these chapters. `failed` means the write was attempted and errored; the chapters in this response are still valid and can be applied manually. - `track_id` string: Mux text track ID of the chapters track created on the asset. Present when status is `created`. - `replaced_track_id` string: Mux text track ID of the chapters track that was deleted to make room for the new one. Absent when the asset had no chapters track. On a `failed` status it means the delete succeeded but the create did not, leaving the asset with no chapters track. ## Other responses - `401`: Missing or invalid Mux credentials - `403`: Robots is not enabled for this environment. Accept the Robots beta terms in the Mux Dashboard to enable access. - `404`: No job exists for the supplied id - `422`: Invalid job ID - `500`: Server error ## Changes - **2026-10-26** `151835caff06`: 1 info - endpoint deprecated - **2026-10-19** `7e2e5079412d`: 3 info - api operation id `get-generate-chapters-job` removed and replaced with `get-generate-chapters-job-v0` - api tag `Generate Chapters (v0)` added - api tag `Generate Chapters` removed - **2026-10-08** `296f0b01bb84`: 11 info - added the non-success response with the status `422` - added the optional property `data/outputs/asset_updates` to the response with the `200` status - added the optional property `error/messages` to the response with the `401` status - added the optional property `error/messages` to the response with the `403` status - …7 more - **2026-09-28** `b57bb059a052`: 1 info - response property `data/parameters/prompt_overrides` deprecated - **2026-09-17** `68a2dd0743bf`: 2 info - added the optional property `data/outputs/asset_update` to the response with the `200` status - added the optional property `data/parameters/update_asset_chapters` to the response with the `200` status [Operation history](https://skmtc.dev/muxinc/apis/mux-api/changes/robots/v0/jobs/generate-chapters/:JOB_ID/get.md) --- [API](https://skmtc.dev/muxinc/apis/mux-api.md) - [All operations](https://skmtc.dev/muxinc/apis/mux-api/llms.txt) - [OpenAPI document](https://skmtc.dev/muxinc/apis/mux-api/revisions/75b4251a1d96?raw)