Dolby · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Dolby OptiView Ad Engine API
11 actions
11 updates
phrasing
extends
openapi/dolby-ad-engine-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Dolby's API. It is a proposal applied on top of the contract, not a document Dolby publishes.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/ad-engine/profile'].get
$.paths['/ad-engine/profile'].put
$.paths['/ad-engine/profile'].post
$.paths['/ad-engine/profile'].delete
$.paths['/ad-engine/profiles'].get
$.paths['/ad-engine/conform'].get
$.paths['/ad-engine/conform-pod'].post
$.paths['/cloud-preview/codemill'].post
$.paths['/cloud-preview/omakase'].post
$.paths['/cloud-preview/hls'].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 Dolby OptiView Ad Engine API
version: 1.0.0
extends: openapi/dolby-ad-engine-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: 10
- target: $.paths['/ad-engine/profile'].get
update:
x-apievangelist-phrasing:
intent: Get an ad encoding profile
effect: read
questions:
- What encoding settings does one of my ad profiles use?
- Can I look up an ad profile by its key?
instructions:
- text: Get ad profile {key} using auth token {auth_token}.
slots:
key: query.key
auth_token: header.x-rasp-auth-token
- text: Show the encode and QC settings of ad profile {key} with token {auth_token}.
slots:
key: query.key
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'
- target: $.paths['/ad-engine/profile'].put
update:
x-apievangelist-phrasing:
intent: Update an ad encoding profile
effect: write
questions:
- How do I change the encode settings on an existing ad profile?
- Can I adjust QC or timing configuration on an ad profile I already made?
instructions:
- text: Update ad profile {key} with encode profile {encode_profile}, token {auth_token}.
slots:
key: query.key
encode_profile: requestBody.encode_profile
auth_token: header.x-rasp-auth-token
- text: Change QC settings on existing ad profile {key} to {qc} using token {auth_token}.
slots:
key: query.key
qc: requestBody.qc
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'
- target: $.paths['/ad-engine/profile'].post
update:
x-apievangelist-phrasing:
intent: Create an ad encoding profile
effect: write
questions:
- How do I define a new encoding profile that ads get conformed to?
- Can a new ad profile include source options and timing configuration?
instructions:
- text: Create ad profile {key} with encode profile {encode_profile}, token {auth_token}.
slots:
key: query.key
encode_profile: requestBody.encode_profile
auth_token: header.x-rasp-auth-token
- text: Set up a new ad profile {key} with source options {source_options}, auth token {auth_token}.
slots:
key: query.key
source_options: requestBody.source_options
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'
- target: $.paths['/ad-engine/profile'].delete
update:
x-apievangelist-phrasing:
intent: Delete an ad encoding profile
effect: destructive
questions:
- How do I remove an ad profile I no longer use?
- Can an ad profile be deleted by its key?
instructions:
- text: Delete ad profile {key} using token {auth_token}.
slots:
key: query.key
auth_token: header.x-rasp-auth-token
- text: Remove the ad encoding profile keyed {key}, auth {auth_token}.
slots:
key: query.key
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'
- target: $.paths['/ad-engine/profiles'].get
update:
x-apievangelist-phrasing:
intent: List all ad encoding profiles
effect: read
questions:
- Which ad encoding profiles do I currently have?
- Can I see every ad profile in one call?
instructions:
- text: List all ad profiles using auth token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
- text: Show every current ad encoding profile, token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'
- target: $.paths['/ad-engine/conform'].get
update:
x-apievangelist-phrasing:
intent: Conform a single ad to an encoding profile
effect: write
questions:
- How do I make one ad creative match my encoding profile?
- Can a single ad be conformed rather than a whole pod?
instructions:
- text: Conform one ad to its encoding profile using auth token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
- text: Run a single-ad conform with token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'
- target: $.paths['/ad-engine/conform-pod'].post
update:
x-apievangelist-phrasing:
intent: Conform an ad pod to an encoding profile
effect: write
questions:
- Can I conform several ads in an ad pod in one request?
- Does the ad pod conform follow the order of the asset URLs I send?
instructions:
- text: Conform the ad pod {asset_urls} using token {auth_token}.
slots:
asset_urls: requestBody.asset_urls
auth_token: header.x-rasp-auth-token
- text: Conform ads {asset_urls} as a pod, follow URL sequence {follow_url_sequence}, token {auth_token}.
slots:
asset_urls: requestBody.asset_urls
follow_url_sequence: requestBody.follow_url_sequence
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'
- target: $.paths['/cloud-preview/codemill'].post
update:
x-apievangelist-phrasing:
intent: Generate an Accurate Player preview template
effect: write
questions:
- How can I preview a cloud media asset in the Codemill Accurate Player?
- Can I get an Accurate Player template for instant playback of an ad asset?
instructions:
- text: Generate an Accurate Player preview template with auth token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
- text: Create a Codemill playback template using token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'
- target: $.paths['/cloud-preview/omakase'].post
update:
x-apievangelist-phrasing:
intent: Generate an Omakase Player session template
effect: write
questions:
- How do I open a cloud asset in an Omakase Player session?
- Can I build an Omakase Player template for instant playback?
instructions:
- text: Generate an Omakase Player session template with auth token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
- text: Create an Omakase preview session using token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'
- target: $.paths['/cloud-preview/hls'].post
update:
x-apievangelist-phrasing:
intent: Generate an HLS preview template
effect: write
questions:
- Can I get an HLS preview of a cloud asset without transcoding it myself?
- What does the HLS preview template give me for instant playback?
instructions:
- text: Generate an HLS preview template with auth token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
- text: Create an HLS playback preview using token {auth_token}.
slots:
auth_token: header.x-rasp-auth-token
method: generated
generated: '2026-10-01'