Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Data API

2 actions 2 updates phrasing extends openapi/khoros-ai-data-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/data/{subscriptionId}'].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 Khoros Ai Data API
  version: 1.0.0
extends: openapi/khoros-ai-data-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: 1
- target: $.paths['/data/{subscriptionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Poll events for a subscription
      effect: read
      questions:
      - How do I fetch the events that arrived for one of my subscriptions?
      - Can I page through subscription events with an offset and limit?
      instructions:
      - text: Get events for subscription {subscription}.
        slots:
          subscription: path.subscriptionId
      - text: Poll up to {limit} events for subscription {subscription} from offset {offset}.
        slots:
          limit: query.limit
          subscription: path.subscriptionId
          offset: query.offset
      method: generated
      generated: '2026-10-01'