Zoom · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoom REST Meeting API

9 actions 9 updates phrasing extends openapi/zoom-meeting-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 9

$.info
$.paths['/meeting/create'].post
$.paths['/meeting/delete'].post
$.paths['/meeting/end'].post
$.paths['/meeting/get'].post
$.paths['/meeting/list'].post
$.paths['/meeting/live'].post
$.paths['/meeting/register'].post
$.paths['/meeting/update'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zoom REST Meeting API
  version: 1.0.0
extends: openapi/zoom-meeting-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: 8
- target: $.paths['/meeting/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a meeting for a host
      effect: write
      questions:
      - How do I create a meeting and get back its join URL?
      - Can I let participants join before the host when scheduling a meeting?
      instructions:
      - text: Create a meeting called {topic} of type {type} for host {host_id}.
        slots:
          topic: requestBody.topic
          type: requestBody.type
          host_id: requestBody.host_id
      - text: Schedule {topic} (type {type}) for host {host_id} at {start_time} in {timezone}.
        slots:
          topic: requestBody.topic
          type: requestBody.type
          host_id: requestBody.host_id
          start_time: requestBody.start_time
          timezone: requestBody.timezone
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meeting/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a meeting
      effect: destructive
      questions:
      - Can I delete a single occurrence of a recurring meeting?
      - What gets returned when a scheduled meeting is deleted?
      instructions:
      - text: Delete meeting {id} for host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Delete occurrence {occurrence_id} of recurring meeting {id}, host {host_id}.
        slots:
          occurrence_id: requestBody.occurrence_id
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meeting/end'].post
  update:
    x-apievangelist-phrasing:
      intent: End a meeting in progress
      effect: destructive
      questions:
      - Is there a way to force a running meeting to end for everyone?
      - Can I shut down a meeting a host left open?
      instructions:
      - text: End the running meeting {id} for host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Shut down meeting {id} that host {host_id} left open.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meeting/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a meeting's info
      effect: read
      questions:
      - What are the settings and schedule of a particular meeting?
      - Can I look up a meeting by its ID and host?
      instructions:
      - text: Get the info for meeting {id}, host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Show me how meeting {id} for host {host_id} is set up.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meeting/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List a host's scheduled meetings
      effect: read
      questions:
      - What meetings does a host have scheduled?
      - Can I page through all of one host's scheduled meetings?
      instructions:
      - text: List the scheduled meetings for host {host_id}.
        slots:
          host_id: requestBody.host_id
      - text: Show page {page_number} of host {host_id}'s scheduled meetings.
        slots:
          page_number: requestBody.page_number
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meeting/live'].post
  update:
    x-apievangelist-phrasing:
      intent: List meetings that are live now
      effect: read
      questions:
      - Which meetings are happening on the account right now?
      - Can I see every live meeting at this moment?
      instructions:
      - text: List the meetings that are live right now.
      - text: Show live meetings using API key {api_key} and secret {api_secret}.
        slots:
          api_key: requestBody.api_key
          api_secret: requestBody.api_secret
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meeting/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register someone for a meeting
      effect: write
      questions:
      - How can I sign a person up for a meeting that needs registration?
      - Can I register an attendee for chosen occurrences of a recurring meeting?
      instructions:
      - text: Register {first_name} {last_name} ({email}) for meeting {id}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
          id: requestBody.id
      - text: Sign up {email}, {first_name} {last_name}, for occurrences {occurrence_ids} of meeting {id}.
        slots:
          email: requestBody.email
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          occurrence_ids: requestBody.occurrence_ids
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meeting/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing meeting
      effect: write
      questions:
      - Can I reschedule a meeting that's already on the calendar?
      - What can I change on an existing meeting, like its password or duration?
      instructions:
      - text: Move existing meeting {id} (type {type}, host {host_id}) to {start_time}.
        slots:
          id: requestBody.id
          type: requestBody.type
          host_id: requestBody.host_id
          start_time: requestBody.start_time
      - text: Change the password on existing meeting {id} (type {type}, host {host_id}) to {password}.
        slots:
          id: requestBody.id
          type: requestBody.type
          host_id: requestBody.host_id
          password: requestBody.password
      method: generated
      generated: '2026-09-24'