Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai By Source Document ID API

2 actions 2 updates phrasing extends openapi/khoros-ai-bysourcedocumentid-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['/bySourceDocumentId/networks/{network}/instances/{instance}/id/{source document id}'].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 By Source Document ID API
  version: 1.0.0
extends: openapi/khoros-ai-bysourcedocumentid-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['/bySourceDocumentId/networks/{network}/instances/{instance}/id/{source document id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conversation by source document ID
      effect: read
      questions:
      - How do I find the conversation a specific social post belongs to?
      - Can I look up conversation details from the network's own document ID?
      instructions:
      - text: Get the conversation for source document {docId} on {network} instance {instance}.
        slots:
          docId: path.source document id
          network: path.network
          instance: path.instance
      - text: Find which conversation contains post {docId} from {network} ({instance}).
        slots:
          docId: path.source document id
          network: path.network
          instance: path.instance
      method: generated
      generated: '2026-10-01'