Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Control API

3 actions 3 updates phrasing extends openapi/khoros-ai-control-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['/control/network/{networkKey}/externalId/{externalId}/author/{authorId}'].get

$.paths['/control'].put

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 Control API
  version: 1.0.0
extends: openapi/khoros-ai-control-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['/control/network/{networkKey}/externalId/{externalId}/author/{authorId}'].get
  update:
    x-apievangelist-phrasing:
      intent: See whether a bot or agent controls a conversation
      effect: read
      questions:
      - Is a bot or a human agent currently in control of a customer's conversation?
      - How do I check who owns the conversation with a specific author on a network?
      instructions:
      - text: Check who controls the conversation with author {author} on network {network} for bot {external}.
        slots:
          author: path.authorId
          network: path.networkKey
          external: path.externalId
      - text: Tell me if a bot or agent has author {author} on {network} via channel {external}.
        slots:
          author: path.authorId
          network: path.networkKey
          external: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/control'].put
  update:
    x-apievangelist-phrasing:
      intent: Pass conversation control between bot and agent
      effect: write
      questions:
      - How does a bot hand a conversation over to a human agent?
      - Can I pass control of a conversation back to the bot?
      instructions:
      - text: Pass conversation control using payload {payload}.
        slots:
          payload: requestBody.RAW_BODY
      - text: Hand this conversation from the bot to an agent.
      method: generated
      generated: '2026-10-01'