Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Video Participants API

7 actions 7 updates phrasing extends openapi/twilio-participants-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/Rooms/{RoomSid}/Participants'].get
$.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}'].get
$.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}'].post
$.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks'].get
$.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules'].get
$.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules'].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 Twilio Video Participants API
  version: 1.0.0
extends: openapi/twilio-participants-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: 6
- target: $.paths['/Rooms/{RoomSid}/Participants'].get
  update:
    x-apievangelist-phrasing:
      intent: List participants who joined a video room
      effect: read
      questions:
      - Who has connected to a particular video room?
      - Can I narrow a room's participant list by status or identity?
      instructions:
      - text: List the participants in video room {room}.
        slots:
          room: path.RoomSid
      - text: List participants in room {room} with status {status}.
        slots:
          room: path.RoomSid
          status: query.Status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one participant in a video room
      effect: read
      questions:
      - What details are stored about a single participant in a room?
      - Can I check whether one specific person is still in a video room?
      instructions:
      - text: Fetch participant {participant_sid} in room {room}.
        slots:
          participant_sid: path.ParticipantSid
          room: path.RoomSid
      - text: Show the record for participant {participant_sid} of room {room}.
        slots:
          participant_sid: path.ParticipantSid
          room: path.RoomSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Disconnect a participant from a video room
      effect: write
      questions:
      - Can I remove someone from a video room from my server?
      - What status disconnects a participant from a room?
      instructions:
      - text: Disconnect participant {participant_sid} from room {room} by setting status {status}.
        slots:
          participant_sid: path.ParticipantSid
          room: path.RoomSid
          status: requestBody.Status
      - text: Kick {participant_sid} out of video room {room}, status {status}.
        slots:
          participant_sid: path.ParticipantSid
          room: path.RoomSid
          status: requestBody.Status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracks a participant has published
      effect: read
      questions:
      - Which audio and video tracks has a participant published to the room?
      - Is a participant sharing their camera or screen right now?
      instructions:
      - text: List the published tracks for participant {participant_sid} in room {room}.
        slots:
          participant_sid: path.ParticipantSid
          room: path.RoomSid
      - text: Show what participant {participant_sid} is publishing in room {room}.
        slots:
          participant_sid: path.ParticipantSid
          room: path.RoomSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a participant's subscribe rules
      effect: read
      questions:
      - What rules decide which tracks a participant receives?
      - Can I read the current subscribe rules for one participant?
      instructions:
      - text: Get the subscribe rules for participant {participant_sid} in room {room}.
        slots:
          participant_sid: path.ParticipantSid
          room: path.RoomSid
      - text: Show which tracks participant {participant_sid} in room {room} is set to receive.
        slots:
          participant_sid: path.ParticipantSid
          room: path.RoomSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules'].post
  update:
    x-apievangelist-phrasing:
      intent: Control which tracks a participant receives
      effect: write
      questions:
      - Can I stop a participant from receiving certain tracks in a room?
      - What format do subscribe rules use when I change them?
      instructions:
      - text: Set subscribe rules {rules} for participant {participant_sid} in room {room}.
        slots:
          rules: requestBody.Rules
          participant_sid: path.ParticipantSid
          room: path.RoomSid
      - text: Change what participant {participant_sid} in room {room} receives using rules {rules}.
        slots:
          participant_sid: path.ParticipantSid
          room: path.RoomSid
          rules: requestBody.Rules
      method: generated
      generated: '2026-09-26'