Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Request API

3 actions 3 updates phrasing extends openapi/khoros-ai-request-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 3

$.info
$.paths['/request/{requestId}'].get
$.paths['/request/appId/{appId})/'].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 Khoros Ai Request API
  version: 1.0.0
extends: openapi/khoros-ai-request-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['/request/{requestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Monitor a single bot request
      effect: read
      questions:
      - How do I check what happened to one request my bot sent?
      - Can I trace a specific Bot v3 request by its ID?
      instructions:
      - text: Show the status of bot request {requestId}.
        slots:
          requestId: path.requestId
      - text: Trace request {requestId} to the Bot API.
        slots:
          requestId: path.requestId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/request/appId/{appId})/'].get
  update:
    x-apievangelist-phrasing:
      intent: Monitor bot requests by date, state and origin
      effect: read
      questions:
      - How do I see all the requests my bot app made since a date?
      - Can I filter bot requests by state or origin?
      instructions:
      - text: List requests for bot app {appId} since {from}.
        slots:
          appId: path.appId
          from: query.from
      - text: Show requests for app {appId} in state {state} from origin {origin}.
        slots:
          appId: path.appId
          state: query.state
          origin: query.origin
      method: generated
      generated: '2026-10-01'