Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dolby OptiView Ad Engine Cloud Preview API

6 actions 6 updates phrasing extends openapi/dolby-cloud-preview-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/media-info'].get
$.paths['/image'].get
$.paths['/cloud-preview/codemill'].post
$.paths['/cloud-preview/omakase'].post
$.paths['/cloud-preview/hls'].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 Dolby OptiView Ad Engine Cloud Preview API
  version: 1.0.0
extends: openapi/dolby-cloud-preview-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: 5
- target: $.paths['/media-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Inspect a cloud media file's technical info
      effect: read
      questions:
      - What codec, duration and track details does a media file in cloud storage have?
      - Can I inspect a media file in a private bucket using stored credentials?
      instructions:
      - text: Get media info for {url} using auth token {auth_token}.
        slots:
          url: query.url
          auth_token: header.x-rasp-auth-token
      - text: Inspect {url} with credentials key {credentials_key}, auth token {auth_token}.
        slots:
          url: query.url
          credentials_key: query.credentials_key
          auth_token: header.x-rasp-auth-token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/image'].get
  update:
    x-apievangelist-phrasing:
      intent: Grab a still frame from a cloud video
      effect: read
      questions:
      - Can I pull a thumbnail frame from a video sitting in cloud storage?
      - How do I choose the frame position and image size for a preview still?
      instructions:
      - text: Grab a still from {url} using auth token {auth_token}.
        slots:
          url: query.url
          auth_token: header.x-rasp-auth-token
      - text: Capture a {width}x{height} frame from {url} at {offset_percent} percent in, token {auth_token}.
        slots:
          width: query.width
          height: query.height
          url: query.url
          offset_percent: query.offset_percent
          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 asset in the Codemill Accurate Player?
      - Can I get an Accurate Player template for instant cloud playback?
      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'