Qualified · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qualified Enterprise Messages API

3 actions 3 updates phrasing extends openapi/qualified-com-messages-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Qualified's API. It is a proposal applied on top of the contract, not a document Qualified publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v2/messages'].get

$.paths['/v2/messages/{id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Qualified Enterprise Messages API
  version: 1.0.0
extends: openapi/qualified-com-messages-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['/v2/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List messages across all conversations
      effect: read
      questions:
      - How do I export every chat message across all conversations for a date range?
      - Are system event messages left out of the messages export?
      - How long after a session ends do its messages become available?
      instructions:
      - text: List all chat messages created since {created_after}.
        slots:
          created_after: query.created_after
      - text: Export messages across every conversation between {created_after} and {created_before}.
        slots:
          created_after: query.created_after
          created_before: query.created_before
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/messages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one chat message by id
      effect: read
      questions:
      - Can I fetch a single chat message by its id?
      - Why does looking up an event message by id return not found?
      instructions:
      - text: Get message {id}.
        slots:
          id: path.id
      - text: Show the text and sender of chat message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'