API Evangelist conversational phrasing for Mux Com Live Streams API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mux Com Live Streams API
  version: 1.0.0
extends: openapi/mux-com-live-streams-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 22
- target: $.paths['/video/v1/live_streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List live streams (live_streams path)
      effect: read
      questions:
      - Is there an older underscore live_streams route to list my streams?
      - Which live streams does the live_streams listing return?
      instructions:
      - text: List my live streams using the live_streams underscore path.
      - text: Call the legacy live_streams listing.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live_streams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a live stream (live_streams path)
      effect: write
      questions:
      - Can I create a live stream through the live_streams underscore route?
      - What's the legacy live_streams call for making a new stream?
      instructions:
      - text: Create a live stream using the live_streams underscore path.
      - text: Make a new stream with the legacy live_streams create call.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live_streams/{LIVE_STREAM_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a live stream (live_streams path)
      effect: read
      questions:
      - Can I fetch a stream's details through the underscore live_streams route?
      - Which call retrieves one stream on the legacy live_streams path?
      instructions:
      - text: Get live stream {live_stream_id} via the live_streams underscore path.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      - text: Look up stream {live_stream_id} with the legacy live_streams call.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List live streams
      effect: read
      questions:
      - Which of my live streams are currently active?
      - Can I find a live stream by its stream key?
      instructions:
      - text: List my live streams.
      - text: List live streams with status {status}.
        slots:
          status: query.status
      - text: Find the live stream using stream key {stream_key}.
        slots:
          stream_key: query.stream_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a live stream
      effect: write
      questions:
      - How do I set up a new live stream my encoder can broadcast to?
      - Can I create a low-latency live stream that records to an asset?
      - Is there a way to make a test live stream?
      instructions:
      - text: Create a new live stream with a {playback_policy} playback policy.
        slots:
          playback_policy: requestBody.playback_policy
      - text: Create a live stream in {latency_mode} latency mode.
        slots:
          latency_mode: requestBody.latency_mode
      - text: Set up a live stream with a reconnect window of {reconnect_window} seconds.
        slots:
          reconnect_window: requestBody.reconnect_window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a live stream's details
      effect: read
      questions:
      - What's the stream key and status of one of my live streams?
      - Is my live stream idle or active right now?
      instructions:
      - text: Show live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      - text: Get the stream key and status of live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a live stream
      effect: destructive
      questions:
      - What happens to an active broadcast if I delete the live stream?
      - How do I permanently remove a live stream?
      instructions:
      - text: Delete live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      - text: Permanently remove live stream {live_stream_id} and disconnect its encoder.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a live stream's settings
      effect: write
      questions:
      - Can I change the latency mode of a stream I already created?
      - How do I change the reconnect window on an existing live stream?
      instructions:
      - text: Switch existing live stream {live_stream_id} to {latency_mode} latency.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          latency_mode: requestBody.latency_mode
      - text: Set the reconnect window of live stream {live_stream_id} to {reconnect_window} seconds.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          reconnect_window: requestBody.reconnect_window
      - text: Cap live stream {live_stream_id} at {max_continuous_duration} seconds of continuous streaming.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          max_continuous_duration: requestBody.max_continuous_duration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a playback ID to a live stream
      effect: write
      questions:
      - How do I get another playback URL for viewers of my live stream?
      - Can I add a signed playback ID to a live stream?
      instructions:
      - text: Add a playback ID to live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      - text: Create a {policy} playback ID for live stream {live_stream_id}.
        slots:
          policy: requestBody.policy
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a live stream's playback ID
      effect: read
      questions:
      - What policy does one of my live stream's playback IDs use?
      - Can I look up a single playback ID on a live stream?
      instructions:
      - text: Show playback ID {playback_id} of live stream {live_stream_id}.
        slots:
          playback_id: path.PLAYBACK_ID
          live_stream_id: path.LIVE_STREAM_ID
      - text: Get details of live stream {live_stream_id}'s playback {playback_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          playback_id: path.PLAYBACK_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a playback ID from a live stream
      effect: destructive
      questions:
      - Will deleting a live stream's playback ID stop the broadcast ingest?
      - How do I block new viewers from one live stream playback URL?
      instructions:
      - text: Delete playback ID {playback_id} from live stream {live_stream_id}.
        slots:
          playback_id: path.PLAYBACK_ID
          live_stream_id: path.LIVE_STREAM_ID
      - text: Revoke live stream {live_stream_id} playback {playback_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          playback_id: path.PLAYBACK_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a live stream's stream key
      effect: destructive
      questions:
      - My stream key leaked — how do I get a new one immediately?
      - Does resetting a stream key stop the old key from working?
      instructions:
      - text: Reset the stream key for live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      - text: Rotate live stream {live_stream_id}'s stream key now.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/complete'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark a live stream as finished
      effect: write
      questions:
      - How do I end a live recording right away instead of waiting for the reconnect window?
      - Can I tell players the broadcast is over so they stop waiting?
      instructions:
      - text: Signal live stream {live_stream_id} is complete.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      - text: End the recording of live stream {live_stream_id} now.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/disable'].put
  update:
    x-apievangelist-phrasing:
      intent: Disable a live stream
      effect: destructive
      questions:
      - How do I stop a live stream from accepting any incoming RTMP broadcasts?
      - Does disabling a stream also end the current recording?
      instructions:
      - text: Disable live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      - text: Block incoming broadcasts on live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Re-enable a disabled live stream
      effect: write
      questions:
      - How do I let a disabled live stream accept broadcasts again?
      - Can I turn a live stream back on after disabling it?
      instructions:
      - text: Enable live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      - text: Allow live stream {live_stream_id} to accept RTMP again.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure embedded closed captions on a stream
      effect: write
      questions:
      - Can my live stream pick up closed captions embedded in the incoming broadcast?
      - How do I turn on embedded captions for a live stream?
      instructions:
      - text: Set embedded subtitles on live stream {live_stream_id} to {embedded_subtitles}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          embedded_subtitles: requestBody.embedded_subtitles
      - text: Enable embedded closed captions for live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/generated-subtitles'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure auto-generated live subtitles
      effect: write
      questions:
      - Can Mux add speech-recognition captions to my live stream?
      - How do I remove auto-generated subtitles from a live stream?
      instructions:
      - text: Set generated subtitles on live stream {live_stream_id} to {generated_subtitles}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          generated_subtitles: requestBody.generated_subtitles
      - text: Turn off speech-recognition captions for live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a simulcast target to a live stream
      effect: write
      questions:
      - How do I restream my live broadcast to another RTMP destination?
      - Does a live stream need to be idle before adding a simulcast target?
      instructions:
      - text: Add simulcast target {url} to live stream {live_stream_id}.
        slots:
          url: requestBody.url
          live_stream_id: path.LIVE_STREAM_ID
      - text: Simulcast live stream {live_stream_id} to {url} with stream key {stream_key}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          url: requestBody.url
          stream_key: requestBody.stream_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a simulcast target's details
      effect: read
      questions:
      - What's the status of a restream destination on my live stream?
      - Can I check where a simulcast target is sending my stream?
      instructions:
      - text: Show simulcast target {simulcast_target_id} on live stream {live_stream_id}.
        slots:
          simulcast_target_id: path.SIMULCAST_TARGET_ID
          live_stream_id: path.LIVE_STREAM_ID
      - text: Get the status of simulcast {simulcast_target_id} for stream {live_stream_id}.
        slots:
          simulcast_target_id: path.SIMULCAST_TARGET_ID
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a simulcast target
      effect: destructive
      questions:
      - How do I stop restreaming to one of my simulcast destinations?
      - Can I delete a simulcast target while the stream is live?
      instructions:
      - text: Delete simulcast target {simulcast_target_id} from live stream {live_stream_id}.
        slots:
          simulcast_target_id: path.SIMULCAST_TARGET_ID
          live_stream_id: path.LIVE_STREAM_ID
      - text: Stop simulcasting live stream {live_stream_id} to target {simulcast_target_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          simulcast_target_id: path.SIMULCAST_TARGET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions'].put
  update:
    x-apievangelist-phrasing:
      intent: Set MP4 renditions for a stream's recordings
      effect: write
      questions:
      - Can future recordings of my live stream automatically get MP4 renditions?
      - Do I have to list every static rendition when changing a stream's recording settings?
      instructions:
      - text: Set static renditions {static_renditions} for new assets from live stream {live_stream_id}.
        slots:
          static_renditions: requestBody.static_renditions
          live_stream_id: path.LIVE_STREAM_ID
      - text: Make recordings of live stream {live_stream_id} produce renditions {static_renditions}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
          static_renditions: requestBody.static_renditions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop MP4 renditions for a stream's recordings
      effect: destructive
      questions:
      - How do I stop future live recordings from creating MP4 renditions?
      - Can I clear the static rendition setting on a live stream?
      instructions:
      - text: Remove the static renditions setting from live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      - text: Stop creating MP4s for new recordings of live stream {live_stream_id}.
        slots:
          live_stream_id: path.LIVE_STREAM_ID
      method: generated
      generated: '2026-09-26'