Mailosaur · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mailosaur Analysis API

3 actions 3 updates phrasing extends openapi/mailosaur-analysis-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Mailosaur's API. It is a proposal applied on top of the contract, not a document Mailosaur publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/analysis/spam/{messageId}'].get
$.paths['/api/analysis/deliverability/{messageId}'].get

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 Mailosaur Analysis API
  version: 1.0.0
extends: openapi/mailosaur-analysis-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: 2
- target: $.paths['/api/analysis/spam/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a test email for spam
      effect: read
      questions:
      - Will my email be flagged as spam by filters?
      - Can I run a spam check on an email that landed in my Mailosaur inbox?
      - What spam score did my password reset email get?
      instructions:
      - text: Run a spam analysis on message {messageId}.
        slots:
          messageId: path.messageId
      - text: Check whether email {messageId} looks like spam and show me the score.
        slots:
          messageId: path.messageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analysis/deliverability/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deliverability report for an email
      effect: read
      questions:
      - How can I tell if my email will actually reach recipients' inboxes?
      - Is there a deliverability report for a captured test email?
      - What deliverability problems does my welcome email have?
      instructions:
      - text: Generate a deliverability report for message {messageId}.
        slots:
          messageId: path.messageId
      - text: Show me what could stop email {messageId} from being delivered.
        slots:
          messageId: path.messageId
      method: generated
      generated: '2026-10-01'