Zoom · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoom / Account Meeting Live Stream API

4 actions 4 updates phrasing extends openapi/zoom-meeting-live-stream-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Zoom's API. It is a proposal applied on top of the contract, not a document Zoom publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/meetings/{meetingId}/livestream'].patch

$.paths['/meetings/{meetingId}/livestream/status'].patch

$.paths['/meetings/{meetingId}/jointoken/live_streaming'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zoom / Account Meeting Live Stream API
  version: 1.0.0
extends: openapi/zoom-meeting-live-stream-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/meetings/{meetingId}/livestream'].patch
  update:
    x-apievangelist-phrasing:
      intent: Configure a meeting's live stream
      effect: write
      questions:
      - How do I set up a meeting to stream to a custom streaming service?
      - Does the live stream need to be configured before the meeting starts?
      instructions:
      - text: Set meeting {meetingId} to live stream to {stream_url} with key {stream_key}.
        slots:
          meetingId: path.meetingId
          stream_url: requestBody.stream_url
          stream_key: requestBody.stream_key
      - text: Configure streaming for {meetingId} to {stream_url} (key {stream_key}), viewer page {page_url}.
        slots:
          meetingId: path.meetingId
          stream_url: requestBody.stream_url
          stream_key: requestBody.stream_key
          page_url: requestBody.page_url
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meetings/{meetingId}/livestream/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Start or stop a meeting's live stream
      effect: write
      questions:
      - Can I start live streaming while a meeting is already running?
      - How can I stop a live stream without ending the meeting?
      instructions:
      - text: Start the live stream for meeting {meetingId}.
        slots:
          meetingId: path.meetingId
      - text: Apply live stream action {action} to meeting {meetingId}.
        slots:
          action: requestBody.action
          meetingId: path.meetingId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meetings/{meetingId}/jointoken/live_streaming'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a join token for live streaming a meeting
      effect: read
      questions:
      - How does a streaming service or recording bot get permission to join a meeting?
      - What is a live streaming join token used for?
      instructions:
      - text: Get a live streaming join token for meeting {meetingId}.
        slots:
          meetingId: path.meetingId
      - text: Issue a token so a streaming bot can join meeting {meetingId}.
        slots:
          meetingId: path.meetingId
      method: generated
      generated: '2026-09-24'