Gumlet · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Gumlet Live Stream Assets API
10 actions
10 updates
phrasing
extends
openapi/gumlet-live-stream-assets-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Gumlet's API. It is a proposal applied on top of the contract, not a document Gumlet publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/video/live/assets'].post
$.paths['/video/live/assets/update'].post
$.paths['/video/live/assets/{live_asset_id}'].get
$.paths['/video/live/assets/{live_asset_id}'].delete
$.paths['/video/live/assets/{live_asset_id}/complete'].post
$.paths['/video/live/assets/list/{live_source_id}'].get
$.paths['/video/live/assets/{live_asset_id}/start'].post
$.paths['/video/live/assets/thumbnail/upload'].post
$.paths['/video/live/assets/{live_asset_id}/history'].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 Gumlet Live Stream Assets API
version: 1.0.0
extends: openapi/gumlet-live-stream-assets-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 9
- target: $.paths['/video/live/assets'].post
update:
x-apievangelist-phrasing:
intent: Create a live stream
effect: write
questions:
- How do I set up a new live stream to push video into?
- Can I schedule a live stream for a future start time?
- Which resolution and orientation options are there for a live stream?
instructions:
- text: Create a {resolution} live stream in live workspace {live_source_id}.
slots:
resolution: requestBody.resolution
live_source_id: requestBody.live_source_id
- text: Create live stream {title} in {live_source_id} at {resolution}, starting {start_at}.
slots:
title: requestBody.title
live_source_id: requestBody.live_source_id
resolution: requestBody.resolution
start_at: requestBody.start_at
method: generated
generated: '2026-10-01'
- target: $.paths['/video/live/assets/update'].post
update:
x-apievangelist-phrasing:
intent: Rename or reschedule a live stream
effect: write
questions:
- Can I change the title of a live stream I already created?
- Is it possible to move a scheduled live stream to a new start time?
instructions:
- text: Rename live stream {live_asset_id} to {title}.
slots:
live_asset_id: requestBody.live_asset_id
title: requestBody.title
- text: Reschedule live stream {live_asset_id} to start at {start_at}.
slots:
live_asset_id: requestBody.live_asset_id
start_at: requestBody.start_at
method: generated
generated: '2026-10-01'
- target: $.paths['/video/live/assets/{live_asset_id}'].get
update:
x-apievangelist-phrasing:
intent: Check a live stream's status
effect: read
questions:
- Is my live stream currently connected and broadcasting?
- Where do I find the stream key and playback details for a live stream?
instructions:
- text: Get the status of live stream {live_asset_id}.
slots:
live_asset_id: path.live_asset_id
- text: Show details for live asset {live_asset_id}.
slots:
live_asset_id: path.live_asset_id
method: generated
generated: '2026-10-01'
- target: $.paths['/video/live/assets/{live_asset_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a live stream
effect: destructive
questions:
- Will deleting a live stream also remove its recording and URLs?
- Can I permanently get rid of an old live stream?
instructions:
- text: Delete live stream {live_asset_id}.
slots:
live_asset_id: path.live_asset_id
- text: Permanently remove live asset {live_asset_id} and its storage.
slots:
live_asset_id: path.live_asset_id
method: generated
generated: '2026-10-01'
- target: $.paths['/video/live/assets/{live_asset_id}/complete'].post
update:
x-apievangelist-phrasing:
intent: End a live stream for good
effect: destructive
questions:
- How do I mark a live stream as finished so it stops accepting input?
- Can a live stream be reused after it's marked complete?
instructions:
- text: Mark live stream {live_asset_id} complete.
slots:
live_asset_id: path.live_asset_id
- text: Finish live asset {live_asset_id} so it no longer ingests.
slots:
live_asset_id: path.live_asset_id
method: generated
generated: '2026-10-01'
- target: $.paths['/video/live/assets/list/{live_source_id}'].get
update:
x-apievangelist-phrasing:
intent: List live streams by status
effect: read
questions:
- Which of my live streams are currently active?
- Can I list all live streams in a workspace filtered by status?
instructions:
- text: List live streams in workspace {live_source_id}.
slots:
live_source_id: path.live_source_id
- text: Show {status} live streams in workspace {live_source_id}.
slots:
status: query.status
live_source_id: path.live_source_id
method: generated
generated: '2026-10-01'
- target: $.paths['/video/live/assets/{live_asset_id}/start'].post
update:
x-apievangelist-phrasing:
intent: Start a live stream
effect: write
questions:
- What call actually kicks off a live broadcast?
- Can I start a scheduled live stream right now?
instructions:
- text: Start live stream {live_asset_id}.
slots:
live_asset_id: path.live_asset_id
- text: Go live on live asset {live_asset_id} now.
slots:
live_asset_id: path.live_asset_id
method: generated
generated: '2026-10-01'
- target: $.paths['/video/live/assets/thumbnail/upload'].post
update:
x-apievangelist-phrasing:
intent: Upload thumbnails for live stream states
effect: write
questions:
- Can I show a custom image while my live stream is preparing or disconnected?
- Which live stream states support their own thumbnail image?
instructions:
- text: Get thumbnail upload URLs for live stream {live_asset_id} for states {statuses}.
slots:
live_asset_id: requestBody.live_asset_id
statuses: requestBody.statuses
- text: Prepare an end-of-stream thumbnail upload for live asset {live_asset_id}, states {statuses}.
slots:
live_asset_id: requestBody.live_asset_id
statuses: requestBody.statuses
method: generated
generated: '2026-10-01'
- target: $.paths['/video/live/assets/{live_asset_id}/history'].get
update:
x-apievangelist-phrasing:
intent: View a live stream's status history
effect: read
questions:
- When did my live stream connect, disconnect and end?
- Can I see the timeline of status changes for a past live stream?
instructions:
- text: Show the status history of live stream {live_asset_id}.
slots:
live_asset_id: path.live_asset_id
- text: Get the connect and disconnect timeline for live asset {live_asset_id}.
slots:
live_asset_id: path.live_asset_id
method: generated
generated: '2026-10-01'