Generate Chapters

Create a 'generate-chapters' job

Changed on

Creates a new job that uses AI to generate chapters for a Mux Video asset. Optional output steering can guide chapter style, granularity, audience, and brand terms without changing the response schema.

post/robots/v1/jobs/generate-chapters

Request

  • Base URL
    https://api.mux.com
  • Auth
    • HTTP basic
    • or HTTP bearer

Request body

passthroughstring

Arbitrary string stored with the job and returned in responses. Useful for correlating jobs with your own systems.

Example request

{
  "parameters": {
    "asset_id": "mux_asset_123abc",
    "update_asset_chapters": true,
    "output_steering": {
      "chapter_style": "descriptive",
      "chapter_granularity": "balanced",
      "audience": "Developers"
    }
  }
}

Response

Job queued

Example response

{
  "data": {
    "parameters": {
      "asset_id": "mux_asset_123abc",
      "update_asset_chapters": true,
      "output_steering": {
        "chapter_style": "descriptive",
        "chapter_granularity": "balanced",
        "audience": "Developers"
      }
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "chapters": [
        {
          "start_time": 0,
          "title": "Introduction"
        }
      ],
      "asset_updates": {
        "chapters": {
          "status": "created",
          "track_id": "chaptersabc123def456",
          "replaced_track_ids": [
            "old_chapters_track"
          ]
        }
      }
    }
  }
}

Changes