# 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 Tests API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-tests-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: 16
- target: $.paths['/api/tests'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an inbox placement test from the web
      effect: write
      questions:
      - How do I run a free inbox placement test for my email address?
      - Can I choose which mailbox providers the web placement test checks?
      instructions:
      - text: Start a placement test for {email}.
        slots:
          email: requestBody.email
      - text: Run a web inbox check for {email} against providers {providers}.
        slots:
          email: requestBody.email
          providers: requestBody.providers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tests/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a web placement test by token
      effect: read
      questions:
      - Where do I see the results of a placement test I started on the website?
      - Can I open a web test's report with just its token?
      instructions:
      - text: Show web placement test {token}.
        slots:
          token: path.token
      - text: Get the results of inbox check {token} from the website.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tests/{token}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a web placement test
      effect: destructive
      questions:
      - Can I remove a placement test I ran on the website?
      - How do I delete a test that has no API key, only a token?
      instructions:
      - text: Delete web placement test {token}.
        slots:
          token: path.token
      - text: Remove inbox check {token} I started on the site.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tests/{token}/live'].get
  update:
    x-apievangelist-phrasing:
      intent: Stream live results of a test
      effect: read
      questions:
      - Can I watch placement results arrive in real time?
      - Is there a live feed of a test's progress?
      instructions:
      - text: Stream live updates for test {token}.
        slots:
          token: path.token
      - text: Follow test {token} live as seeds report in.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/track/click'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a tracked click
      effect: write
      questions:
      - Is there an endpoint that records link clicks for tracking?
      - Can clicks be logged without any parameters in the URL?
      instructions:
      - text: Record a tracked click event.
      - text: Log a click to the tracker.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tests/{token}/finish'].post
  update:
    x-apievangelist-phrasing:
      intent: Finish a check and get its partial report
      effect: write
      questions:
      - Can I end a placement check early and keep what's been found so far?
      - What do I get back when I finish a test before all seeds report?
      instructions:
      - text: Finish test {token} and return its partial report.
        slots:
          token: path.token
      - text: Stop checking {token} now and save the partial results.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tests/{token}/warmup'].post
  update:
    x-apievangelist-phrasing:
      intent: Move spam-placed test emails to inbox
      effect: write
      questions:
      - Can I move my test emails that landed in spam back to the inbox as a not-spam signal?
      - Is the free warmup safe to call twice for the same test?
      instructions:
      - text: Run free warmup on test {token} to move its spam-placed emails to Inbox.
        slots:
          token: path.token
      - text: Mark test {token}'s spam emails as not spam on the seed mailboxes.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tests/{token}/repoll'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-poll a test by public token
      effect: write
      questions:
      - My web test email arrived late; can I make the seeds re-check without an API key?
      - How long is the cooldown between public re-polls of a test?
      instructions:
      - text: Re-poll seeds for web test {token} using only its token.
        slots:
          token: path.token
      - text: Force an IMAP re-check of public test {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/tests'].get
  update:
    x-apievangelist-phrasing:
      intent: List my deliverability tests
      effect: read
      questions:
      - Which deliverability tests has my API key created?
      - Can I page back through older tests or filter them by status?
      instructions:
      - text: List my last {limit} deliverability tests with status {status}.
        slots:
          limit: query.limit
          status: query.status
      - text: Show tests created before {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/tests'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a manual deliverability test
      effect: write
      questions:
      - How do I test where my campaign email lands across all seed mailboxes?
      - Can I request screenshots of where the email landed?
      instructions:
      - text: Create a manual deliverability test across providers {providers}.
        slots:
          providers: requestBody.providers
      - text: Give me seed addresses for a placement test with recipient {recipient}, screenshots on.
        slots:
          recipient: requestBody.recipient_email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/tests/auto'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an auto-mode test for one recipient
      effect: write
      questions:
      - Can I test placement for one recipient by letting the provider be detected from their MX?
      - What seed is used when the recipient is on a custom domain?
      instructions:
      - text: Create an auto-mode deliverability test for recipient {recipient}.
        slots:
          recipient: requestBody.recipient_email
      - text: Auto-test placement of mail from {sender} to {recipient}.
        slots:
          sender: requestBody.sender_email
          recipient: requestBody.recipient_email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/tests/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a test's results as JSON or PDF
      effect: read
      questions:
      - Did my email land in inbox or spam, and did SPF, DKIM and DMARC pass?
      - Can I download a deliverability test result as a PDF?
      instructions:
      - text: Show the results of deliverability test {token}.
        slots:
          token: path.token
      - text: Download test {token} as {format}.
        slots:
          token: path.token
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/tests/{token}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deliverability test
      effect: destructive
      questions:
      - Can I permanently delete a test and its screenshots through the API?
      - Is deleting a v1 test reversible?
      instructions:
      - text: Delete deliverability test {token} and its results.
        slots:
          token: path.token
      - text: Permanently remove API test {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/tests/{token}/repoll'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-poll a test's seeds with an API key
      effect: write
      questions:
      - Delivery was delayed past the window; how do I make my API test re-check its seeds?
      - Does an API re-poll use up test quota?
      instructions:
      - text: Re-poll every seed of API test {token} now.
        slots:
          token: path.token
      - text: Trigger a one-shot IMAP fetch for owned test {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/tests/{token}/recheck'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a delayed placement recheck
      effect: write
      questions:
      - Can I check whether the same email moved between inbox and spam a day later?
      - Does a delayed recheck send a new email or cost quota?
      instructions:
      - text: Schedule a placement recheck of test {token} in {hours} hours.
        slots:
          token: path.token
          hours: requestBody.delay_hours
      - text: Recheck where test {token}'s message sits tomorrow.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/tests/{token}/recheck-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get delayed recheck snapshots
      effect: read
      questions:
      - Did my email's placement change between the first check and the delayed recheck?
      - Where do I read the transition matrix from a scheduled recheck?
      instructions:
      - text: Show recheck snapshots and transitions for test {token}.
        slots:
          token: path.token
      - text: Compare the original and delayed placement of test {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-10-01'