Generate Premium Captions (v0)

Create a 'generate-premium-captions' job

Changed on

Deprecated: use POST /robots/v1/jobs/generate-premium-captions instead. Creates a new job that generates high-quality captions for a Mux Video asset.

post/robots/v0/jobs/generate-premium-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",
    "language_code": "en",
    "replace_existing_tracks": "fail",
    "include_speakers": false,
    "include_words": false,
    "upload_to_mux": true,
    "phrases": [
      "Mux",
      "API"
    ]
  }
}

Response

Caption generation job queued

Example response

{
  "data": {
    "parameters": {
      "asset_id": "mux_asset_123abc",
      "language_code": "en",
      "replace_existing_tracks": "fail",
      "include_speakers": false,
      "include_words": false,
      "upload_to_mux": true,
      "phrases": [
        "Mux",
        "API"
      ]
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "track_id": "enabc123def456",
      "language_code": "en",
      "detected_language": "en",
      "auto_language_confidence": 1,
      "temporary_srt_url": "https://storage.example.com/captions/en/abc123.srt?token=abc"
    }
  }
}

Changes

    • info

      endpoint deprecated

    • info

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

    • info

      api tag Generate Premium Captions (v0) added

    • info

      api tag Generate Premium Captions removed