Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Media Player Streamers API

7 actions 7 updates phrasing extends openapi/twilio-playerstreamers-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['/v1/PlayerStreamers/{Sid}'].get

$.paths['/v1/PlayerStreamers/{Sid}'].post

$.paths['/v1/PlayerStreamers'].get

$.paths['/v1/PlayerStreamers'].post

$.paths['/v1/PlayerStreamers/{Sid}/PlaybackGrant'].get

$.paths['/v1/PlayerStreamers/{Sid}/PlaybackGrant'].post

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 Twilio - Media Player Streamers API
  version: 1.0.0
extends: openapi/twilio-playerstreamers-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['/v1/PlayerStreamers/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a live stream player streamer
      effect: read
      questions:
      - What state is my live stream's PlayerStreamer in right now?
      - Can I look up a single PlayerStreamer by its SID?
      instructions:
      - text: Show PlayerStreamer {streamer}.
        slots:
          streamer: path.Sid
      - text: Check whether PlayerStreamer {streamer} has started or ended.
        slots:
          streamer: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/PlayerStreamers/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: End a live stream PlayerStreamer
      effect: destructive
      questions:
      - How do I stop a PlayerStreamer that is still live?
      - Can I end a live stream by changing the PlayerStreamer's status?
      instructions:
      - text: Set PlayerStreamer {streamer} status to {status}.
        slots:
          streamer: path.Sid
          status: requestBody.Status
      - text: End the live stream on PlayerStreamer {streamer} by setting status {status}.
        slots:
          streamer: path.Sid
          status: requestBody.Status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/PlayerStreamers'].get
  update:
    x-apievangelist-phrasing:
      intent: List my PlayerStreamers
      effect: read
      questions:
      - Which of my live streams are currently started?
      - Can I list PlayerStreamers that failed, oldest first?
      instructions:
      - text: List all my PlayerStreamers.
      - text: List PlayerStreamers with status {status} sorted {order}.
        slots:
          status: query.Status
          order: query.Order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/PlayerStreamers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a PlayerStreamer for a live stream
      effect: write
      questions:
      - How do I set up a new PlayerStreamer to broadcast a live stream?
      - Can I create an audio-only stream and cap how long it runs?
      - Is there a way to get webhook events for every PlayerStreamer status change?
      instructions:
      - text: Create a new PlayerStreamer.
      - text: Create an audio-only PlayerStreamer with video set to {video} that ends after {max_duration} seconds.
        slots:
          video: requestBody.Video
          max_duration: requestBody.MaxDuration
      - text: Create a PlayerStreamer that posts status events to {callback}.
        slots:
          callback: requestBody.StatusCallback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/PlayerStreamers/{Sid}/PlaybackGrant'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a PlayerStreamer playback grant
      effect: read
      questions:
      - Can I read back the playback grant already issued for a PlayerStreamer?
      - Is fetching an existing playback grant supported, or is that method disabled?
      instructions:
      - text: Fetch the existing playback grant for PlayerStreamer {streamer}.
        slots:
          streamer: path.Sid
      - text: Look up the playback grant already on {streamer}.
        slots:
          streamer: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/PlayerStreamers/{Sid}/PlaybackGrant'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a playback grant so viewers can watch
      effect: write
      questions:
      - How do I give a viewer's player access to watch my live stream?
      - Can I restrict a playback grant to my own website's origin?
      - What is the longest time to live a new playback grant can have?
      instructions:
      - text: Create a playback grant for PlayerStreamer {streamer}.
        slots:
          streamer: path.Sid
      - text: Issue a playback grant for {streamer} valid for {ttl} seconds, only from {origin}.
        slots:
          streamer: path.Sid
          ttl: requestBody.Ttl
          origin: requestBody.AccessControlAllowOrigin
      method: generated
      generated: '2026-09-26'