# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Video Creatives Video Creative Management (V3) API
  version: 1.0.0
extends: openapi/mediamath-video-creative-management-v3-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: 15
- target: $.paths['/v3.0/creatives/bulk'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk create video creatives
      effect: write
      questions:
      - Can I upload a whole set of new video creatives in one request?
      - How do I bulk create video ads instead of adding them one at a time?
      instructions:
      - text: 'Bulk create these video creatives: {creatives}.'
        slots:
          creatives: requestBody.creatives
      - text: 'Upload this set of new video ads in one bulk create: {creatives}.'
        slots:
          creatives: requestBody.creatives
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/bulk'].patch
  update:
    x-apievangelist-phrasing:
      intent: Bulk update video creatives
      effect: write
      questions:
      - Is there a way to edit many existing video creatives at once?
      - Can I deactivate a batch of video creatives in a single call?
      instructions:
      - text: 'Bulk update these existing video creatives: {creatives}.'
        slots:
          creatives: requestBody.creatives
      - text: 'Apply these edits to many video creatives at once: {creatives}.'
        slots:
          creatives: requestBody.creatives
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a video creative
      effect: write
      questions:
      - How do I create a new video creative and upload its video file?
      - Can a new video creative use a custom VAST URL instead of a file?
      - What fields are required to create one video creative?
      instructions:
      - text: Create video creative {name} for advertiser {advertiser} in concept {concept}.
        slots:
          name: requestBody.name
          advertiser: requestBody.advertiser
          concept: requestBody.concept
      - text: Create a video creative named {name} for advertiser {advertiser} from file {file}.
        slots:
          name: requestBody.name
          advertiser: requestBody.advertiser
          file: requestBody.fileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Get several video creatives by ID
      effect: read
      questions:
      - Can I fetch multiple video creatives at once if I have their IDs?
      - What's the quickest way to look up a batch of video creatives by ID?
      instructions:
      - text: Fetch video creatives {ids}.
        slots:
          ids: requestBody.creativeIds
      - text: Look up the video creatives with IDs {ids} in one request.
        slots:
          ids: requestBody.creativeIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a video creative's status and details
      effect: read
      questions:
      - What is the status of a single video creative?
      - Has my video creative finished processing?
      instructions:
      - text: Get video creative {creative}.
        slots:
          creative: path.creativeId
      - text: Check the processing status of video creative {creative}.
        slots:
          creative: path.creativeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace a video creative (full update)
      effect: write
      questions:
      - If I resend a video creative without some fields, are they removed?
      - How do I overwrite every field of a video creative in one update?
      instructions:
      - text: Fully replace video creative {creative} with name {name} for advertiser {advertiser}.
        slots:
          creative: path.creativeId
          name: requestBody.name
          advertiser: requestBody.advertiser
      - text: Overwrite all fields of video creative {creative}, naming it {name} for advertiser {advertiser}.
        slots:
          creative: path.creativeId
          name: requestBody.name
          advertiser: requestBody.advertiser
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a video creative
      effect: write
      questions:
      - Can I change just the clickthrough URL on a video creative without resending everything?
      - How do I tweak one field on a single video creative?
      instructions:
      - text: Change only the clickthrough URL of video creative {creative} to {url}.
        slots:
          creative: path.creativeId
          url: requestBody.clickthroughUrl
      - text: Patch video creative {creative} to set active to {active}.
        slots:
          creative: path.creativeId
          active: requestBody.active
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/validateVAST'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate VAST XML
      effect: read
      questions:
      - Is my VAST XML valid before I attach it to a creative?
      - What errors or warnings does my VAST document have?
      instructions:
      - text: Validate this VAST XML and report errors and warnings.
      - text: Check my VAST document for problems before I use it.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List a video creative's change history
      effect: read
      questions:
      - Who changed a video creative and when?
      - Can I see a video creative's history between two dates?
      instructions:
      - text: Show the change history for video creative {creative}.
        slots:
          creative: path.creativeId
      - text: List history for video creative {creative} created after {after}.
        slots:
          creative: path.creativeId
          after: query.created_after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}/history'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a video creative's history entry
      effect: destructive
      questions:
      - Can I remove history entries recorded for a video creative?
      - Is it possible to clear the change log on a video creative?
      instructions:
      - text: Delete the history entry for video creative {creative}.
        slots:
          creative: path.creativeId
      - text: Clear the history record on video creative {creative}.
        slots:
          creative: path.creativeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}/companions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a video creative's companion ads
      effect: read
      questions:
      - What companion banners are attached to my video creative?
      - Does this video creative have any companion ads?
      instructions:
      - text: List companion ads for video creative {creative}.
        slots:
          creative: path.creativeId
      - text: Show every companion banner attached to video creative {creative}.
        slots:
          creative: path.creativeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}/companions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a companion ad to a video creative
      effect: write
      questions:
      - How do I attach a companion banner to a video creative?
      - Can I add a companion ad from a resource URL rather than uploading a file?
      instructions:
      - text: Add a companion ad with {details} to video creative {creative}.
        slots:
          details: requestBody.details
          creative: path.creativeId
      - text: Attach a companion from {url} to video creative {creative}.
        slots:
          url: requestBody.resourceUrl
          creative: path.creativeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}/companions/{companionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one companion ad
      effect: read
      questions:
      - What are the details of a specific companion on my video creative?
      - Can I read a single companion ad by its ID?
      instructions:
      - text: Get companion {companion} on video creative {creative}.
        slots:
          companion: path.companionId
          creative: path.creativeId
      - text: Show the details of companion ad {companion} for video creative {creative}.
        slots:
          companion: path.companionId
          creative: path.creativeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}/companions/{companionId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a companion ad
      effect: write
      questions:
      - How do I change an existing companion ad's image or details?
      - Does updating a companion regenerate the creative's MetaVAST?
      instructions:
      - text: Update companion {companion} on video creative {creative} with {details}.
        slots:
          companion: path.companionId
          creative: path.creativeId
          details: requestBody.details
      - text: Point companion {companion} on video creative {creative} at resource {url}.
        slots:
          companion: path.companionId
          creative: path.creativeId
          url: requestBody.resourceUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3.0/creatives/{creativeId}/companions/{companionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a companion ad
      effect: destructive
      questions:
      - How do I remove a companion ad from a video creative?
      - Can I detach one companion banner and keep the video?
      instructions:
      - text: Delete companion {companion} from video creative {creative}.
        slots:
          companion: path.companionId
          creative: path.creativeId
      - text: Remove companion ad {companion} from video creative {creative}.
        slots:
          companion: path.companionId
          creative: path.creativeId
      method: generated
      generated: '2026-10-01'