MUmuxinc
Summarize (v0)

Create a 'summarize' job

Changed on

Deprecated: use POST /robots/v1/jobs/summarize instead. Creates a new job that uses AI to generate a title, description, and tags for a Mux Video asset. Optional output steering can restrict execution to a time scope in seconds and guide summary style, audience, brand terms, and tag taxonomy without changing the response schema.

post/robots/v0/jobs/summarize

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",
    "tone": "neutral",
    "tag_count": 10,
    "update_asset_meta": true,
    "output_steering": {
      "scope": {
        "start_time": 30,
        "end_time": 180
      },
      "summary_style": "concise",
      "audience": "Product marketers",
      "brand_terms": [
        "Mux",
        "Robots"
      ]
    }
  }
}

Response

Summarize job queued

Example response

{
  "data": {
    "parameters": {
      "asset_id": "mux_asset_123abc",
      "tone": "neutral",
      "tag_count": 10,
      "update_asset_meta": true,
      "output_steering": {
        "scope": {
          "start_time": 30,
          "end_time": 180
        },
        "summary_style": "concise",
        "audience": "Product marketers",
        "brand_terms": [
          "Mux",
          "Robots"
        ]
      }
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "title": "How to Build a Sustainable Garden in Your Backyard",
      "description": "This video walks through the step-by-step process of creating a sustainable backyard garden, covering soil preparation, plant selection, and organic pest control methods.",
      "tags": [
        "gardening",
        "sustainability",
        "backyard",
        "organic",
        "soil preparation",
        "composting",
        "pest control",
        "beginner",
        "how-to",
        "plants"
      ],
      "asset_updates": {
        "title": {
          "status": "updated"
        }
      }
    }
  }
}

Changes

  • 151835caff06Revision changes
    • info

      endpoint deprecated

  • 7e2e5079412dRevision changes
    • breaking

      added to the // request property allOf list

    • warning

      removed from the // request property allOf list

    • info

      api operation id create-summarize-job removed and replaced with create-summarize-job-v0

    • info

      api tag Summarize (v0) added

    • info

      api tag Summarize removed

    • info

      added to the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status