Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stream-api Entities.json?entity Ids API

2 actions 2 updates phrasing extends openapi/khoros-ai-entities-json-entity-ids-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}/entities.json?entity_ids'].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 stream-api Entities.json?entity Ids API
  version: 1.0.0
extends: openapi/khoros-ai-entities-json-entity-ids-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}/entities.json?entity_ids'].get
  update:
    x-apievangelist-phrasing:
      intent: Get specific approved items from a stream
      effect: read
      questions:
      - How do I fetch particular approved items from a stream by their IDs?
      - Can I request several stream entities at once?
      instructions:
      - text: Get entities {entity_ids} from {account}/{streamName}.
        slots:
          account: path.account
          streamName: path.streamName
          entity_ids: query.entity_ids
      - text: Fetch the approved items with IDs {entity_ids} in stream {streamName} for {account}.
        slots:
          account: path.account
          streamName: path.streamName
          entity_ids: query.entity_ids
      method: generated
      generated: '2026-10-01'