MUmuxinc
Generate Chapters (v0)

Create a 'generate-chapters' job

Changed on

Deprecated: use POST /robots/v1/jobs/generate-chapters instead. 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/v0/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

Chapters 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": {
      "asset_updates": {
        "chapters": {
          "status": "created",
          "track_id": "chaptersabc123def456"
        }
      },
      "chapters": [
        {
          "start_time": 0,
          "title": "Introduction"
        },
        {
          "start_time": 45,
          "title": "Setting Up the Workspace"
        },
        {
          "start_time": 180,
          "title": "Core Implementation"
        },
        {
          "start_time": 420,
          "title": "Testing and Debugging"
        },
        {
          "start_time": 600,
          "title": "Wrap-Up and Next Steps"
        }
      ]
    }
  }
}

Changes

  • 151835caff06Revision changes
    • info

      endpoint deprecated

  • 7e2e5079412dRevision changes
    • info

      api operation id create-generate-chapters-job removed and replaced with create-generate-chapters-job-v0

    • info

      api tag Generate Chapters (v0) added

    • info

      api tag Generate Chapters removed