Dolby

Dolby Monetized Stream API

The Monetized-Stream API from Dolby — 7 operation(s) for monetized-stream.

GitHub OpenAPI

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/monetized-streams List all monetized streams · Get monetized streams #
Ask an LLM
“Which monetized streams have I deployed?”
“Can I see every signaling service along with its configuration?”
Tell an agent
List all my monetized streams.
Show every deployed ad signaling service and its config.
POST /v1/monetized-streams Deploy a new monetized stream · Create monetized stream #
Ask an LLM
“How do I set up ad insertion for a live stream?”
“What does a new monetized stream need besides a stream ID and layout?”
Tell an agent
Create a monetized stream for stream {streamId} with layout {layout}.
Deploy monetized stream {name} for {streamId} using layout {layout}.
GET /v1/monetized-streams/{monetizedStreamId} Get one monetized stream · Get monetized stream #
Ask an LLM
“What is the configuration of one monetized stream?”
“Can I look up a signaling service by its monetized stream ID?”
Tell an agent
Show monetized stream {monetizedStreamId}.
Get the config of signaling service {monetizedStreamId}.
PATCH /v1/monetized-streams/{monetizedStreamId} Update a monetized stream · Update monetized stream #
Ask an LLM
“Can I change the origin or backdrop of an existing monetized stream?”
“Is it possible to rename a monetized stream after deployment?”
Tell an agent
Rename monetized stream {monetizedStreamId} to {name}.
Set the origin of monetized stream {monetizedStreamId} to {origin}.
DELETE /v1/monetized-streams/{monetizedStreamId} Delete a monetized stream · Delete monetized stream #
Ask an LLM
“How do I tear down a monetized stream's signaling service?”
“Can I remove a monetized stream I no longer run ads on?”
Tell an agent destructive · confirm first
Delete monetized stream {monetizedStreamId}.
Tear down signaling service {monetizedStreamId}.
PATCH /v1/monetized-streams/{monetizedStreamId}/layout Change a monetized stream's default layout · Update monetized stream layout #
Ask an LLM
“How do I switch only the default ad layout on a monetized stream?”
“Can I change the layout without touching the rest of the stream config?”
Tell an agent
Change the default layout of monetized stream {monetizedStreamId} to {layout}.
Use layout {layout} as the default for {monetizedStreamId}.
POST /v1/monetized-streams/{monetizedStreamId}/break Schedule an ad break · Create monetized stream break #
Ask an LLM
“How do I insert an ad break into a live monetized stream?”
“Can I set a duration or end date when scheduling an ad break?”
Tell an agent
Create ad break {id} on monetized stream {monetizedStreamId} starting at {startDate}.
Schedule ad break {id} on {monetizedStreamId} at {startDate} lasting {duration}.
GET /v1/monetized-streams/{monetizedStreamId}/break List all ad breaks on a monetized stream · Get monetized stream breaks #
Ask an LLM
“Which ad breaks are scheduled on a monetized stream?”
“Can I get every ad break for a stream in one unpaginated call?”
Tell an agent
List all ad breaks on monetized stream {monetizedStreamId}.
Show the full ad break schedule for {monetizedStreamId}.
DELETE /v1/monetized-streams/{monetizedStreamId}/break/{adbreakId} Delete an ad break · Delete monetized stream breaks #
Ask an LLM
“How do I cancel an ad break I already scheduled?”
“Can I remove a single ad break from a monetized stream?”
Tell an agent destructive · confirm first
Delete ad break {adbreakId} from monetized stream {monetizedStreamId}.
Cancel ad break {adbreakId} on {monetizedStreamId}.
PATCH /v1/monetized-streams/{monetizedStreamId}/break/{adbreakId} Update an ad break · Update monetized stream breaks #
Ask an LLM
“Can I move an existing ad break to a different start time?”
“Is it possible to change the duration of an ad break already created?”
Tell an agent
Move ad break {adbreakId} on {monetizedStreamId} to start at {startDate}.
Change the duration of ad break {adbreakId} on {monetizedStreamId} to {duration}.
POST /v1/monetized-streams/{monetizedStreamId}/overlay Add an overlay ad to a stream · Create monetized stream overlay #
Ask an LLM
“How do I show a banner overlay ad on a live stream?”
“Can I set an overlay's position, size and opacity?”
Tell an agent
Create overlay {id} of type {type} on {monetizedStreamId} starting {startDate} for {duration} at {position} sized {size}.
Add a {type} overlay {id} to monetized stream {monetizedStreamId} with click-through {clickThroughURI}.
GET /v1/monetized-streams/{monetizedStreamId}/overlay List all overlays on a monetized stream · Get monetized stream overlays #
Ask an LLM
“Which overlay ads are attached to a monetized stream?”
“Can I fetch every overlay for a stream without paging?”
Tell an agent
List all overlays on monetized stream {monetizedStreamId}.
Show every overlay ad linked to {monetizedStreamId}.
DELETE /v1/monetized-streams/{monetizedStreamId}/overlay/{overlayId} Delete an overlay ad · Delete monetized stream overlay #
Ask an LLM
“How do I take an overlay ad off a monetized stream?”
“Can I delete one overlay without affecting the others?”
Tell an agent destructive · confirm first
Delete overlay {overlayId} from monetized stream {monetizedStreamId}.
Remove overlay ad {overlayId} on {monetizedStreamId}.

Documentation

📖
Documentation
https://optiview.dolby.com/docs/theolive/
📖
APIReference
https://optiview.dolby.com/docs/theolive/api/theolive-api/
📖
Authentication
https://optiview.dolby.com/docs/theolive/api/authentication/
📖
Documentation
https://optiview.dolby.com/docs/millicast/
📖
APIReference
https://optiview.dolby.com/docs/millicast/api/millicast-api/
📖
Documentation
https://optiview.dolby.com/docs/ads/
📖
APIReference
https://optiview.dolby.com/docs/ads/api/
📖
Documentation
https://optiview.dolby.com/docs/ad-engine/
📖
APIReference
https://optiview.dolby.com/docs/ad-engine/reference/dolby-optiview-ad-engine/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dolby/refs/heads/main/openapi/dolby-monetized-stream-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/dolby/refs/heads/main/asyncapi/dolby-webhooks.yml
🔗
StatusPage
https://status.theo.live
🔗
ChangeLog
https://optiview.dolby.com/docs/millicast/changelog/changelog-rest-apis/
🔗
StatusPage
https://status.dolby.io

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/dolby:dolby-monetized-stream-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dolby-monetized-stream-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: THEOads Monetized Stream API
  version: 25.9.0
  description: The THEOads REST API allows you to create and manage monetized streams, which are deployments of signaling services. Each monetized stream corresponds to an origin stream that is monetized using THEOads (SGAI). For detailed information on the various parameters and their usage, please refer to the getting started guide.
  license:
    name: UNLICENSED
  contact: {}
servers:
- url: /ads-client/api
tags:
- name: Monetized-Stream
paths:
  /v1/monetized-streams:
    get:
      operationId: GetMonetizedStreams
      responses:
        '200':
          description: List of monetized streams
          content:
            application/json:
              schema:
                anyOf:
                - items:
                    $ref: '#/components/schemas/IMonetizedStreamApiResponse'
                  type: array
                - type: string
      description: Retrieves all created and deployed monetized streams (signaling services) along with their configurations.
      tags:
      - Monetized-Stream
      security: []
      parameters: []
      summary: Get monetized streams
      x-summary-source: derived
    post:
      operationId: CreateMonetizedStream
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IMonetizedStreamApiResponse'
      description: Creates and deploys a new monetized stream in the environment, resulting in a deployment of a signaling service.
      tags:
      - Monetized-Stream
      security: []
      parameters: []
      requestBody:
        description: The monetized stream configuration
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IMonetizedStream'
              description: The monetized stream configuration
      summary: Create monetized stream
      x-summary-source: derived
  /v1/monetized-streams/{monetizedStreamId}:
    get:
      operationId: GetMonetizedStream
      responses:
        '200':
          description: A monetized stream
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IMonetizedStreamApiResponse'
      description: Retrieves a single monetized stream (signaling service) based on its identifier, along with its configuration details.
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      summary: Get monetized stream
      x-summary-source: derived
    patch:
      operationId: UpdateMonetizedStream
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IMonetizedStreamApiResponse'
      description: Updates a single monetized stream (signaling service) based on its identifier, along with its configuration update.
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      requestBody:
        description: The monetized stream configuration update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IMonetizedStreamUpdate'
              description: The monetized stream configuration update
      summary: Update monetized stream
      x-summary-source: derived
    delete:
      operationId: DeleteMonetizedStream
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IMonetizedStreamApiResponse'
      description: Deletes a single monetized stream (signaling service) based on its identifier.
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      summary: Delete monetized stream
      x-summary-source: derived
  /v1/monetized-streams/{monetizedStreamId}/layout:
    patch:
      operationId: UpdateMonetizedStreamLayout
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IMonetizedStreamApiResponse'
      description: Updates the default layout for an existing monetized stream (signaling service).
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      requestBody:
        description: The layout configuration
        required: true
        content:
          application/json:
            schema:
              properties:
                layout:
                  $ref: '#/components/schemas/MonetizedStreamLayout'
              required:
              - layout
              type: object
              description: The layout configuration
      summary: Update monetized stream layout
      x-summary-source: derived
  /v1/monetized-streams/{monetizedStreamId}/break:
    post:
      operationId: CreateMonetizedStreamBreak
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/IAdBreakApiResponse'
                - type: string
      description: Creates an ad break on an existing monetized stream (signaling service).
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      requestBody:
        description: The ad break configuration
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IAdBreak'
              description: The ad break configuration
      summary: Create monetized stream break
      x-summary-source: derived
    get:
      operationId: GetMonetizedStreamBreaks
      responses:
        '200':
          description: A monetized stream
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/IAdBreaksApiResponse'
                - type: string
      description: Retrieves all adbreaks linked to the monetized sctream
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      summary: Get monetized stream breaks
      x-summary-source: derived
  /v1/monetized-streams/{monetizedStreamId}/break/{adbreakId}:
    delete:
      operationId: DeleteMonetizedStreamBreaks
      responses:
        '200':
          description: An abreak
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IAdBreakApiResponse'
      description: Deletes an adbreak linked to the monetized sctream
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      - description: The adbreak identifier.
        in: path
        name: adbreakId
        required: true
        schema:
          type: string
      summary: Delete monetized stream breaks
      x-summary-source: derived
    patch:
      operationId: UpdateMonetizedStreamBreaks
      responses:
        '200':
          description: An adbreak
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IAdBreakApiResponse'
      description: Patches an adbreak linked to the monetized sctream
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      - description: The adbreak identifier.
        in: path
        name: adbreakId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IAdBreakUpdate'
      summary: Update monetized stream breaks
      x-summary-source: derived
  /v1/monetized-streams/{monetizedStreamId}/overlay:
    post:
      operationId: CreateMonetizedStreamOverlay
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IOverlayApiResponse'
      description: Creates an overlay on an existing monetized stream (signaling service).
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      requestBody:
        description: The overlay configuration
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IOverlay'
              description: The overlay configuration
      summary: Create monetized stream overlay
      x-summary-source: derived
    get:
      operationId: GetMonetizedStreamOverlays
      responses:
        '200':
          description: A monetized stream
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/IOverlaysApiResponse'
                - type: string
      description: Retrieves all overlays linked to the monetized sctream
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      summary: Get monetized stream overlays
      x-summary-source: derived
  /v1/monetized-streams/{monetizedStreamId}/overlay/{overlayId}:
    delete:
      operationId: DeleteMonetizedStreamOverlay
      responses:
        '200':
          description: A monetized stream
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IOverlayApiResponse'
      description: Deletes an overlay linked to the monetized sctream
      tags:
      - Monetized-Stream
      security: []
      parameters:
      - description: The Monetized stream identifier.
        in: path
        name: monetizedStreamId
        required: true
        schema:
          type: string
      - in: path
        name: overlayId
        required: true
        schema:
          type: string
      summary: Delete monetized stream overlay
      x-summary-source: derived
components:
  schemas:
    IMonetizedStreamApiResponse:
      properties:
        id:
          type: string
        state:
          type: string
          enum:
          - created
          - deleted
        type:
          $ref: '#/components/schemas/ResourceType.MONETIZED_STREAM'
        payload:
          $ref: '#/components/schemas/IMonetizedStream'
      required:
      - id
      - state
      - type
      - payload
      type: object
      additionalProperties: false
    IAdBreakUpdate:
      properties:
        startDate:
          type: string
        endDate:
          type:
          - string
          - 'null'
          format: date-time
        duration:
          type: number
          format: double
        source:
          type: string
        layout:
          $ref: '#/components/schemas/MonetizedStreamLayout'
        assetURI:
          type: string
        status:
          $ref: '#/components/schemas/SignaledAdBreakStatus'
        asset_key:
          type: string
        network_code:
          type: string
        backdropURI:
          type: string
        backdropURIGamProperties:
          $ref: '#/components/schemas/IGamProperties'
        startPts:
          type: number
          format: double
        name:
          type: string
      type: object
      additionalProperties: false
    IAdBreaksApiResponse:
      properties:
        payload:
          items:
            $ref: '#/components/schemas/IAdBreak'
          type: array
        type:
          $ref: '#/components/schemas/ResourceType.AD_BREAK'
        state:
          type: string
          enum:
          - created
          - deleted
        id:
          type: string
      required:
      - payload
      - type
      - state
      - id
      type: object
    ResourceType.MONETIZED_STREAM:
      enum:
      - monetized-stream
      type: string
    MonetizedStreamLayout:
      enum:
      - SINGLE
      - DOUBLE
      - LSHAPE_AD
      - LSHAPE_CONTENT
      type: string
    IAdBreakApiResponse:
      properties:
        payload:
          $ref: '#/components/schemas/IAdBreak'
        type:
          $ref: '#/components/schemas/ResourceType.AD_BREAK'
        state:
          type: string
          enum:
          - created
          - deleted
        id:
          type: string
      required:
      - payload
      - type
      - state
      - id
      type: object
    IOverlay:
      properties:
        name:
          type: string
        id:
          type: string
        startDate:
          type: string
        endDate:
          type: string
        duration:
          type: number
          format: double
        type:
          $ref: '#/components/schemas/OverlayTypes'
        position:
          properties:
            bottom:
              type: number
              format: double
            top:
              type: number
              format: double
            right:
              type: number
              format: double
            left:
              type: number
              format: double
          type: object
        size:
          properties:
            height:
              type: number
              format: double
            width:
              type: number
              format: double
          required:
          - height
          - width
          type: object
        opacity:
          type: number
          format: double
        gamProperties:
          $ref: '#/components/schemas/IGamProperties'
        resourceURI:
          items:
            properties:
              tv:
                type: string
              phone:
                type: string
              default:
                type: string
              type:
                $ref: '#/components/schemas/OverlayURITypes'
            required:
            - default
            - type
            type: object
          type: array
        clickThroughURI:
          type: string
      required:
      - id
      - startDate
      - duration
      - type
      - position
      - size
      type: object
      additionalProperties: false
    MonetizedStreamType:
      enum:
      - LIVE
      - VOD
      type: string
    OverlayTypes:
      enum:
      - image
      type: string
    IOverlayApiResponse:
      properties:
        id:
          type: string
        state:
          type: string
          enum:
          - created
          - deleted
        type:
          type: string
          enum:
          - overlay
        payload:
          $ref: '#/components/schemas/IOverlay'
      required:
      - id
      - state
      - type
      - payload
      type: object
      additionalProperties: false
    IMonetizedStream:
      properties:
        name:
          type: string
        version:
          type: string
        streamId:
          type: string
        streamType:
          $ref: '#/components/schemas/MonetizedStreamType'
        origin:
          type: string
        segmentOrigin:
          type: string
        layout:
          $ref: '#/components/schemas/MonetizedStreamLayout'
        assetKey:
          type: string
        networkCode:
          type: string
        originPath:
          type: string
        assetURI:
          type: string
        backdropURI:
          type: string
        backdropURIGamProperties:
          $ref: '#/components/schemas/IGamProperties'
      required:
      - streamId
      - layout
      type: object
      additionalProperties: false
    IGamProperties:
      properties:
        iu:
          type: string
        sz:
          properties:
            tv:
              type: string
            phone:
              type: string
            default:
              type: string
          required:
          - default
          type: object
      required:
      - iu
      - sz
      type: object
      additionalProperties: false
    IOverlaysApiResponse:
      properties:
        id:
          type: string
        state:
          type: string
          enum:
          - created
          - deleted
        type:
          type: string
          enum:
          - overlay
        payload:
          items:
            $ref: '#/components/schemas/IOverlay'
          type: array
      required:
      - id
      - state
      - type
      - payload
      type: object
      additionalProperties: false
    SignaledAdBreakStatus:
      enum:
      - new
      - future
      - signaled
      - finished
      - error
      - continuous
      type: string
    IMonetizedStreamUpdate:
      properties:
        name:
          type: string
        version:
          type: string
        streamType:
          $ref: '#/components/schemas/MonetizedStreamType'
        origin:
          type: string
        segmentOrigin:
          type: string
        layout:
          $ref: '#/components/schemas/MonetizedStreamLayout'
        originPath:
          type: string
        assetURI:
          type: string
        backdropURI:
          type: string
        backdropURIGamProperties:
          $ref: '#/components/schemas/IGamProperties'
      type: object
      additionalProperties: false
    ResourceType.AD_BREAK:
      enum:
      - adbreak
      type: string
    IAdBreak:
      properties:
        id:
          type: string
        startDate:
          type: string
        endDate:
          type:
          - string
          - 'null'
          format: date-time
        duration:
          type: number
          format: double
        source:
          type: string
        layout:
          $ref: '#/components/schemas/MonetizedStreamLayout'
        assetURI:
          type: string
        status:
          $ref: '#/components/schemas/SignaledAdBreakStatus'
        asset_key:
          type: string
        network_code:
          type: string
        backdropURI:
          type: string
        backdropURIGamProperties:
          $ref: '#/components/schemas/IGamProperties'
        startPts:
          type: number
          format: double
        name:
          type: string
      required:
      - id
      - startDate
      type: object
      additionalProperties: false
    OverlayURITypes:
      enum:
      - png
      - svg
      type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-API-KEY
      in: header