Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stream-api Meta.json?top Periods API

2 actions 2 updates phrasing extends openapi/khoros-ai-meta-json-top-periods-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['/{account}/{streamName}/meta.json?top_periods'].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 stream-api Meta.json?top Periods API
  version: 1.0.0
extends: openapi/khoros-ai-meta-json-top-periods-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['/{account}/{streamName}/meta.json?top_periods'].get
  update:
    x-apievangelist-phrasing:
      intent: Get top tweets for given hourly periods
      effect: read
      questions:
      - What were the top retweeted posts in a stream during certain hours?
      - Can stream meta include top tweets from specific hourly periods?
      instructions:
      - text: Include top tweets from periods {top_periods} in {account}/{streamName} meta.
        slots:
          account: path.account
          streamName: path.streamName
          top_periods: query.top_periods
      - text: Show the most retweeted posts in stream {streamName} on {account} by hour.
        slots:
          account: path.account
          streamName: path.streamName
      method: generated
      generated: '2026-10-01'