# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Creatives / On-Demand API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-creatives-on-demand-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: 8
- target: $.paths['/api/creative-on-demand/{creativeId}/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a personalized creative for a contact
      effect: write
      questions:
      - How do I generate a personalized version of a creative for one contact?
      - Can I save an on-demand generation as a new creative version?
      instructions:
      - text: Generate creative {creativeId} for contact {contactId}.
        slots:
          creativeId: path.creativeId
          contactId: requestBody.contactId
      - text: Queue generation of creative {creativeId} for contact {contactId} with overrides {overrides}.
        slots:
          creativeId: path.creativeId
          contactId: requestBody.contactId
          overrides: requestBody.overrides
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creative-on-demand/{creativeId}/requests/{requestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an on-demand generation request
      effect: read
      questions:
      - Has my on-demand creative generation finished yet?
      - What is the result of a specific generation request?
      instructions:
      - text: Show request {requestId} for creative {creativeId}.
        slots:
          requestId: path.requestId
          creativeId: path.creativeId
      - text: Check the status of on-demand request {requestId} on creative {creativeId}.
        slots:
          requestId: path.requestId
          creativeId: path.creativeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creative-on-demand/{creativeId}/requests/{requestId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an in-flight generation request
      effect: destructive
      questions:
      - Can I cancel an on-demand creative generation that is still running?
      - How do I stop a generation request before it completes?
      instructions:
      - text: Cancel request {requestId} on creative {creativeId}.
        slots:
          requestId: path.requestId
          creativeId: path.creativeId
      - text: Abort the in-flight generation {requestId} for creative {creativeId}.
        slots:
          requestId: path.requestId
          creativeId: path.creativeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creative-on-demand/{creativeId}/requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List on-demand requests for a creative
      effect: read
      questions:
      - Which on-demand generations have been run for a creative?
      - Can I list failed generation requests within a date range?
      instructions:
      - text: List on-demand requests for creative {creativeId} with status {status}.
        slots:
          creativeId: path.creativeId
          status: query.status
      - text: Show creative {creativeId}'s requests from {from} to {to}, {limit} at a time from offset {offset}.
        slots:
          creativeId: path.creativeId
          from: query.from
          to: query.to
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creative-on-demand/{creativeId}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get on-demand generation stats for a creative
      effect: read
      questions:
      - How many personalized generations has a creative produced over a period?
      - What are the aggregate on-demand stats for one creative?
      instructions:
      - text: Show on-demand stats for creative {creativeId}.
        slots:
          creativeId: path.creativeId
      - text: Aggregate creative {creativeId}'s on-demand generations between {from} and {to}.
        slots:
          creativeId: path.creativeId
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creative-on-demand/{creativeId}/qc-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a creative's quality-control settings
      effect: read
      questions:
      - What quality checks run on generated versions of a creative?
      - How is QC configured for one creative?
      instructions:
      - text: Show the QC configuration for creative {creativeId}.
        slots:
          creativeId: path.creativeId
      - text: Get the tier 1 and tier 2 quality checks on creative {creativeId}.
        slots:
          creativeId: path.creativeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creative-on-demand/{creativeId}/qc-config'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a creative's quality-control rules
      effect: write
      questions:
      - Can I define my own two-tier quality checks for a creative's generations?
      - How do I change the QC rules applied to on-demand output?
      instructions:
      - text: Set creative {creativeId}'s QC to tier 1 {tier1} and tier 2 {tier2}.
        slots:
          creativeId: path.creativeId
          tier1: requestBody.tier1
          tier2: requestBody.tier2
      - text: Save QC rules {tier1} and {tier2} for creative {creativeId}.
        slots:
          tier1: requestBody.tier1
          tier2: requestBody.tier2
          creativeId: path.creativeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/creative-on-demand/{creativeId}/qc-config'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a creative's QC settings to defaults
      effect: destructive
      questions:
      - How do I throw away custom QC rules and go back to the defaults?
      - Can I reset a creative's quality checks?
      instructions:
      - text: Reset the QC configuration of creative {creativeId} to defaults.
        slots:
          creativeId: path.creativeId
      - text: Drop custom quality checks on creative {creativeId}.
        slots:
          creativeId: path.creativeId
      method: generated
      generated: '2026-10-01'