Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Email API

2 actions 2 updates phrasing extends openapi/khoros-ai-email-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['/email/{userEmail}/state'].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 Email API
  version: 1.0.0
extends: openapi/khoros-ai-email-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['/email/{userEmail}/state'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an agent's state by email
      effect: write
      questions:
      - How do I change an agent's availability state using their email?
      - Can I set an agent to away by their email address?
      instructions:
      - text: Set the agent {userEmail} to state {stateUUID}.
        slots:
          userEmail: path.userEmail
          stateUUID: query.stateUUID
      - text: Change the status of agent {userEmail}.
        slots:
          userEmail: path.userEmail
      method: generated
      generated: '2026-10-01'