Qualified · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qualified Enterprise Conversations API

4 actions 4 updates phrasing extends openapi/qualified-com-conversations-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 4

$.info

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

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

$.paths['/v2/conversations/{id}/messages'].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 Conversations API
  version: 1.0.0
extends: openapi/qualified-com-conversations-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: 3
- target: $.paths['/v2/conversations'].get
  update:
    x-apievangelist-phrasing:
      intent: List engaged website conversations
      effect: read
      questions:
      - How do I pull every engaged chat conversation that ended last week?
      - Can I list all conversations for one specific website visitor?
      - How soon after a session ends does its conversation appear in the list?
      instructions:
      - text: List conversations that ended between {ended_after} and {ended_before}.
        slots:
          ended_after: query.ended_after
          ended_before: query.ended_before
      - text: Show all conversations for visitor {visitor_id}.
        slots:
          visitor_id: query.visitor_id
      - text: Get the next page of conversations after cursor {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/conversations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one conversation by id
      effect: read
      questions:
      - Can I look up the details of a single chat conversation by its id?
      - Why would fetching a specific conversation return not found?
      instructions:
      - text: Get conversation {id}.
        slots:
          id: path.id
      - text: Show me the details of chat conversation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/conversations/{id}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List the messages in one conversation
      effect: read
      questions:
      - How do I read the full transcript of one specific conversation?
      - Can I fetch only the messages in a conversation sent after a certain time?
      - Are event-type messages included when reading a conversation's transcript?
      instructions:
      - text: List the messages in conversation {id}.
        slots:
          id: path.id
      - text: Show messages in conversation {id} created after {created_after}.
        slots:
          id: path.id
          created_after: query.created_after
      method: generated
      generated: '2026-10-01'