MUmuxinc
Edit Captions

Create an 'edit-captions' job

Changed on

Creates a new job that edits an existing Mux text track using static replacements, speaker-label replacements, and optional profanity censoring. Provide at least one of replacements, speaker_replacements, or auto_censor_profanity.

post/robots/v1/jobs/edit-captions

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",
    "track_id": "text_track_456def",
    "replacements": [
      {
        "find": "Mucks",
        "replace": "Mux",
        "case_sensitive": true
      },
      {
        "find": "gonna",
        "replace": "going to"
      }
    ],
    "speaker_replacements": [
      {
        "find": "speaker_0",
        "replace": "Alice"
      }
    ],
    "upload_to_mux": true,
    "replace_existing_tracks": "replace"
  }
}

Response

Job queued

Example response

{
  "data": {
    "parameters": {
      "asset_id": "mux_asset_123abc",
      "track_id": "text_track_456def",
      "replacements": [
        {
          "find": "Mucks",
          "replace": "Mux",
          "case_sensitive": true
        },
        {
          "find": "gonna",
          "replace": "going to"
        }
      ],
      "speaker_replacements": [
        {
          "find": "speaker_0",
          "replace": "Alice"
        }
      ],
      "upload_to_mux": true,
      "replace_existing_tracks": "replace"
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "total_replacement_count": 5,
      "track_id": "text_track_789ghi",
      "temporary_vtt_url": "https://s3.example.com/edited.vtt?sig=abc",
      "replaced_track_ids": [
        "text_track_456def"
      ]
    }
  }
}

Changes