MUmuxinc
Analyze Structure

Create an 'analyze-structure' job

Changed on

Creates a job that generates a coherent title, summary, tags, chapters, scenes, and key moments from shared evidence for a Mux asset.

post/robots/v1/jobs/analyze-structure

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",
    "language_code": "en",
    "output_language_code": "en",
    "output_steering": {
      "scope": {
        "start_time": 30,
        "end_time": 300
      },
      "audience": "Developers evaluating video APIs",
      "brand_terms": [
        "Mux",
        "Mux Data"
      ],
      "granularity": "balanced"
    },
    "update_asset_meta": true,
    "update_asset_chapters": true
  }
}

Response

Analyze Structure job queued

Example response

{
  "data": {
    "parameters": {
      "asset_id": "mux_asset_123abc",
      "language_code": "en",
      "output_language_code": "en",
      "output_steering": {
        "scope": {
          "start_time": 30,
          "end_time": 300
        },
        "audience": "Developers evaluating video APIs",
        "brand_terms": [
          "Mux",
          "Mux Data"
        ],
        "granularity": "balanced"
      },
      "update_asset_meta": true,
      "update_asset_chapters": true
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "title": "A product demonstration",
      "summary": "A presenter explains the product.",
      "tags": [
        "product demo"
      ],
      "chapters": [
        {
          "start_time": 23.456,
          "end_time": 45.678,
          "title": "Demonstration"
        }
      ],
      "scenes": [],
      "key_moments": []
    }
  }
}

Changes