API Evangelist conversational phrasing for Live Direct Marketing Online Deliverability API

# 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 Deliverability API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-deliverability-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: 13
- target: $.paths['/api/deliverability/probe/relay-reach'].post
  update:
    x-apievangelist-phrasing:
      intent: Probe whether a relay can reach mail providers
      effect: write
      questions:
      - Can my sending relay deliver to Gmail and other mailbox providers at all?
      - How do I run a baseline relay reachability test?
      instructions:
      - text: Start a relay-reach probe to test baseline delivery to mailbox providers.
      - text: Run the C1 relay reachability check.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/probe/creative-through-relay'].post
  update:
    x-apievangelist-phrasing:
      intent: Probe whether a creative reaches the inbox
      effect: write
      questions:
      - Does a specific email creative land in the inbox through my relay?
      - How do I test inbox placement of one creative per mailbox provider?
      instructions:
      - text: Start a creative-through-relay inbox placement probe.
      - text: Run the C2 probe for a creative through a relay.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/matrix'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the deliverability matrix
      effect: read
      questions:
      - Which relays can reach which mailbox providers right now?
      - Can I see the deliverability matrix for just one creative?
      instructions:
      - text: Show the deliverability matrix for relay {relayAccountId}.
        slots:
          relayAccountId: query.relayAccountId
      - text: Get the relay-by-provider matrix for creative {creativeId} since {freshSince}.
        slots:
          creativeId: query.creativeId
          freshSince: query.freshSince
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/probe/creative-tune'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-tune a creative until it reaches the inbox
      effect: write
      questions:
      - Can the system rewrite my creative to get past spam filters?
      - How do I iteratively tune an email creative for one relay and provider?
      instructions:
      - text: Start a creative tuning probe to strip spam markers.
      - text: Run the C3 creative tune until it hits the inbox.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/probe/full-pipeline'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the full deliverability probe pipeline
      effect: write
      questions:
      - Can I test every relay against every provider and auto-tune creatives in one go?
      - What does the full deliverability pipeline run?
      instructions:
      - text: Kick off the full deliverability pipeline across all relays and providers.
      - text: Run all deliverability probes end to end with auto-chained tuning.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/tuned-variants/{id}/promote'].post
  update:
    x-apievangelist-phrasing:
      intent: Promote a tuned variant to a new creative
      effect: write
      questions:
      - How do I save a tuned email variant as a real creative I can use?
      - Can a variant produced by tuning become its own creative?
      instructions:
      - text: Promote tuned variant {id} to a new creative.
        slots:
          id: path.id
      - text: Turn tuned variant {id} into a creative.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/probe/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a probe batch
      effect: read
      questions:
      - Has my deliverability probe batch finished?
      - What's the aggregate result of a probe job so far?
      instructions:
      - text: Get status of probe batch {jobId}.
        slots:
          jobId: path.jobId
      - text: Check how deliverability job {jobId} is going.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/probe/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel pending probes in a batch
      effect: destructive
      questions:
      - Can I stop a deliverability probe batch that's still running?
      - What happens to probes already in flight if I cancel a batch?
      instructions:
      - text: Cancel probe batch {jobId}.
        slots:
          jobId: path.jobId
      - text: Stop the pending probes in deliverability job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/probes'].get
  update:
    x-apievangelist-phrasing:
      intent: List deliverability probe history
      effect: read
      questions:
      - Which deliverability probes failed or timed out recently?
      - Can I filter probe history by relay, provider or layer?
      - What's the most probe records I can pull at once?
      instructions:
      - text: List probes with status {status} since {since}.
        slots:
          status: query.status
          since: query.since
      - text: Show probe history for relay {relayAccountId} to provider {provider}.
        slots:
          relayAccountId: query.relayAccountId
          provider: query.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/block-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List block rules
      effect: read
      questions:
      - Which relay and provider combinations are currently blocked from sending?
      - Can I also see block rules that have already expired?
      instructions:
      - text: List active block rules for relay {relayAccountId}.
        slots:
          relayAccountId: query.relayAccountId
      - text: Show block rules for provider {provider} including expired ({includeExpired}).
        slots:
          provider: query.provider
          includeExpired: query.includeExpired
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/block-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Block a relay from sending to a provider
      effect: write
      questions:
      - How do I stop a relay from sending to a particular mailbox provider?
      - Can a manual block expire automatically after a set time?
      instructions:
      - text: Block relay {relayAccountId} from sending to {provider}.
        slots:
          relayAccountId: requestBody.relayAccountId
          provider: requestBody.provider
      - text: Block relay {relayAccountId} to {provider} until {expiresAtIso} for campaign {campaignId}.
        slots:
          relayAccountId: requestBody.relayAccountId
          provider: requestBody.provider
          expiresAtIso: requestBody.expiresAtIso
          campaignId: requestBody.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/block-rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a block rule
      effect: destructive
      questions:
      - How do I manually unblock a relay that was blocked for a provider?
      - Can I lift a block only for one campaign?
      instructions:
      - text: Delete block rule {id}.
        slots:
          id: path.id
      - text: Unblock rule {id} for campaign {campaignId}.
        slots:
          id: path.id
          campaignId: query.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/deliverability/tuned-variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List tuned creative variants
      effect: read
      questions:
      - Which tuned versions of my creatives has deliverability tuning produced?
      - Can I see the tuned variants of one parent creative?
      instructions:
      - text: List all tuned creative variants.
      - text: Show tuned variants of creative {creativeId}.
        slots:
          creativeId: query.creativeId
      method: generated
      generated: '2026-10-01'