Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online IMAP Orchestrator API

29 actions 29 updates phrasing extends openapi/live-direct-marketing-online-imap-orchestrator-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 29 · first 16 shown; the file carries all of them

$.info
$.paths['/api/imap-orchestrator/stats'].get
$.paths['/api/imap-orchestrator/jobs'].get
$.paths['/api/imap-orchestrator/fetch/{accountId}'].post
$.paths['/api/imap-orchestrator/attention'].get
$.paths['/api/imap-orchestrator/sync-health'].get
$.paths['/api/imap-orchestrator/sync-health/{id}/retry'].post
$.paths['/api/imap-orchestrator/heal'].post
$.paths['/api/imap-orchestrator/heal-all'].post
$.paths['/api/imap-orchestrator/fetch-all'].post
$.paths['/api/imap-orchestrator/tech-log'].get
$.paths['/api/imap-orchestrator/recent-dialogs'].get
$.paths['/api/imap-orchestrator/jobs/{id}'].delete
$.paths['/api/imap-orchestrator/marking-overrides'].get
$.paths['/api/imap-orchestrator/marking-overrides'].post
$.paths['/api/imap-orchestrator/marking-overrides/{id}'].post

OpenAPI Overlay

Raw ↑
# 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 IMAP Orchestrator API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-imap-orchestrator-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: 28
- target: $.paths['/api/imap-orchestrator/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the IMAP orchestrator dashboard stats
      effect: read
      questions:
      - What do the overall inbox-fetching dashboard numbers look like right now?
      - Can I get a summary of how the IMAP orchestrator is performing for my workspace?
      instructions:
      - text: Show me the IMAP orchestrator dashboard stats.
      - text: Give me the headline numbers for mailbox fetching.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent IMAP fetch jobs
      effect: read
      questions:
      - Which IMAP fetch jobs ran recently for one of my mailboxes?
      - Can I filter the recent mailbox fetch jobs by status, like only failed ones?
      instructions:
      - text: List the last {limit} IMAP jobs for email account {accountId} with status {status}.
        slots:
          limit: query.limit
          accountId: query.accountId
          status: query.status
      - text: Show recent IMAP orchestrator jobs for account {accountId}.
        slots:
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/fetch/{accountId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch new mail for one email account now
      effect: write
      questions:
      - Can I force an immediate IMAP fetch for a single mailbox instead of waiting for the schedule?
      - Is there a way to pull new replies into one sending account right away?
      instructions:
      - text: Trigger an IMAP fetch for email account {accountId} now.
        slots:
          accountId: path.accountId
      - text: Pull new inbound mail for mailbox {accountId} manually.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/attention'].get
  update:
    x-apievangelist-phrasing:
      intent: List mailboxes that need manual attention
      effect: read
      questions:
      - Which of my email accounts are stuck and need someone to fix them by hand?
      - Are any connected mailboxes flagged as needing manual intervention?
      instructions:
      - text: List the email accounts that need manual intervention.
      - text: Show me mailboxes flagged for attention by the IMAP orchestrator.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/sync-health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check inbound mail sync health and quarantine
      effect: read
      questions:
      - Is any inbound mail stuck in staging or quarantine for one of my mailboxes?
      - How healthy is the lossless mail sync cursor for my accounts?
      instructions:
      - text: Show mail sync health for account {accountId}, up to {limit} rows.
        slots:
          accountId: query.accountId
          limit: query.limit
      - text: Check the sync cursor, staging and quarantine status for mailbox {accountId}.
        slots:
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/sync-health/{id}/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed or quarantined inbound message
      effect: write
      questions:
      - Can I retry an inbound message that failed to sync or got stuck in quarantine?
      - What happens if I force a re-fetch of an exhausted quarantine row?
      instructions:
      - text: Retry the failed inbound message {id}.
        slots:
          id: path.id
      - text: Force a re-fetch of quarantined sync row {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/heal'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-heal stuck mailbox locks in my workspace
      effect: write
      questions:
      - Can I automatically unstick frozen GAS accounts and IMAP locks for just my workspace?
      - My mailbox fetching seems stuck for this tenant; is there a self-heal action?
      instructions:
      - text: Auto-heal the stuck GAS accounts and IMAP locks for my tenant.
      - text: Run the IMAP self-heal for the current workspace only.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/heal-all'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-heal stuck IMAP state across all tenants
      effect: write
      questions:
      - Is there a platform-wide action to heal stuck IMAP and GAS state for every tenant?
      - As an operator, can I clear stuck mailbox locks across all workspaces at once?
      instructions:
      - text: Heal stuck IMAP and GAS state across all tenants.
      - text: Run the platform-wide IMAP auto-heal for every workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/fetch-all'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch new mail for every active account
      effect: write
      questions:
      - Can I trigger an inbox fetch for all active mailboxes in my workspace at once?
      - What is the quickest way to pull new replies into every sending account I have?
      instructions:
      - text: Trigger an IMAP fetch for every active account in my tenant.
      - text: Fetch new mail for all of my active mailboxes now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/tech-log'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the latest IMAP job log entries
      effect: read
      questions:
      - Where can I see the raw technical log of recent IMAP jobs for monitoring?
      - Can I tail the last few IMAP job log entries?
      instructions:
      - text: Show the latest {limit} IMAP job log entries.
        slots:
          limit: query.limit
      - text: Pull the IMAP tech log for monitoring.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/recent-dialogs'].get
  update:
    x-apievangelist-phrasing:
      intent: List recently received inbound dialogs
      effect: read
      questions:
      - Which inbound conversations were inserted most recently from my mailboxes?
      - Can I see the newest reply threads that came in for one account?
      instructions:
      - text: List the {limit} most recent inbound dialogs for account {accountId}.
        slots:
          limit: query.limit
          accountId: query.accountId
      - text: Show recently inserted inbound dialogs for mailbox {accountId}.
        slots:
          accountId: query.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/jobs/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an IMAP fetch job
      effect: destructive
      questions:
      - Can I stop an IMAP orchestrator job that is queued or running?
      - What happens to a mailbox fetch job if I cancel it?
      instructions:
      - text: Cancel IMAP job {id}.
        slots:
          id: path.id
      - text: Stop the IMAP orchestrator job with id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/marking-overrides'].get
  update:
    x-apievangelist-phrasing:
      intent: List dialog marking override rules
      effect: read
      questions:
      - Which override rules currently change how incoming dialogs get marked?
      - Can I review all the dialog marking overrides set up in my workspace?
      instructions:
      - text: List my dialog marking override rules.
      - text: Show every marking override applied to inbound dialogs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/marking-overrides'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dialog marking override rule
      effect: write
      questions:
      - Can I add an override so certain inbound dialogs are always marked a specific way?
      - Is it possible to define a new rule that overrides automatic reply marking?
      instructions:
      - text: Create a new dialog marking override rule.
      - text: Add a marking override for inbound dialogs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/marking-overrides/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a dialog marking override rule
      effect: write
      questions:
      - Can I change an existing dialog marking override without deleting it?
      - What can I edit on a marking override rule I already created?
      instructions:
      - text: Update dialog marking override {id}.
        slots:
          id: path.id
      - text: Edit the existing marking override rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/marking-overrides/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dialog marking override rule
      effect: destructive
      questions:
      - Can I remove a dialog marking override that is no longer needed?
      - What happens to inbound dialog marking once I delete an override rule?
      instructions:
      - text: Delete dialog marking override {id}.
        slots:
          id: path.id
      - text: Remove the marking override rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/marking-patterns'].get
  update:
    x-apievangelist-phrasing:
      intent: List dialog marking regex patterns
      effect: read
      questions:
      - Which regex patterns are used to classify and mark inbound dialogs?
      - Can I see all the marking patterns configured for reply detection?
      instructions:
      - text: List the dialog marking regex patterns.
      - text: Show me every regex used for marking dialogs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/marking-patterns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dialog marking regex pattern
      effect: write
      questions:
      - Can I add a new regex that marks inbound dialogs matching certain text?
      - Is there a way to teach the dialog marker a new pattern?
      instructions:
      - text: Create a new dialog marking regex pattern.
      - text: Add a regex pattern for marking inbound dialogs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/marking-patterns/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a dialog marking regex pattern
      effect: write
      questions:
      - Can I tweak the regex of an existing dialog marking pattern?
      - What fields can I change on a marking pattern that already exists?
      instructions:
      - text: Update dialog marking pattern {id}.
        slots:
          id: path.id
      - text: Edit the regex on marking pattern {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/marking-patterns/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dialog marking regex pattern
      effect: destructive
      questions:
      - Can I remove a regex pattern that is mis-marking inbound dialogs?
      - Is deleting a dialog marking pattern permanent?
      instructions:
      - text: Delete dialog marking pattern {id}.
        slots:
          id: path.id
      - text: Remove the regex marking pattern {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/health-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List all email accounts for admin health checks
      effect: read
      questions:
      - As an admin, can I see every email account across all tenants to check their health?
      - Which mailboxes exist platform-wide that I could run a connection test on?
      instructions:
      - text: List all email accounts across every tenant for health checks.
      - text: Show the admin health-check roster of mailboxes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/health-test'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an SMTP/IMAP connection test for an account
      effect: write
      questions:
      - Can I test whether a mailbox's SMTP and IMAP connections actually work?
      - Is there a round-trip test that sends and receives through one email account?
      instructions:
      - text: Run an SMTP and IMAP connection test for an email account.
      - text: Do a round-trip mail test on a specific mailbox.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/admin/kill'].post
  update:
    x-apievangelist-phrasing:
      intent: Emergency-stop the IMAP cron
      effect: write
      questions:
      - Is there a kill switch that pauses all scheduled IMAP fetch cycles?
      - Can I halt the IMAP cron in an emergency and record a reason?
      instructions:
      - text: Emergency-stop the IMAP cron triggers.
      - text: Pause all IMAP fetch cycles with the kill switch.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/admin/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume the IMAP cron after a kill
      effect: write
      questions:
      - After hitting the IMAP kill switch, how can I turn scheduled fetching back on?
      - Can I resume the IMAP cron once the emergency is over?
      instructions:
      - text: Resume the IMAP cron after the kill switch.
      - text: Turn scheduled IMAP fetching back on.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/admin/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the IMAP kill-switch state and queues
      effect: read
      questions:
      - Is the IMAP cron currently paused, and why?
      - What are the IMAP queue counts alongside the kill-switch status?
      instructions:
      - text: Show the IMAP kill-switch state and queue counts.
      - text: Tell me whether the IMAP cron is paused right now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/conveyor-health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check inbound conveyor health per step
      effect: read
      questions:
      - Which step of the inbound mail conveyor is backing up for my workspace?
      - Are there delivery reports that the classify pass never covered?
      instructions:
      - text: Show per-step inbound conveyor health for my tenant.
      - text: Check fetch quarantine, relay silence and staging backlog for this workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/conveyor-watchdog/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the inbound conveyor watchdog now
      effect: write
      questions:
      - Can I run the conveyor watchdog immediately so it self-heals stalled inbound steps?
      - Is there a way to force the watchdog to re-enqueue stalled links and send alerts now?
      instructions:
      - text: Run the conveyor watchdog tick across all tenants now.
      - text: Trigger the inbound conveyor self-heal immediately.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/imap-orchestrator/conveyor-watchdog/last'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the last conveyor watchdog result
      effect: read
      questions:
      - What did the most recent conveyor watchdog tick find, without rerunning it?
      - Can I see the previous watchdog run's results across all tenants?
      instructions:
      - text: Show the result of the last conveyor watchdog tick.
      - text: Get the previous watchdog run without recomputing it.
      method: generated
      generated: '2026-10-01'