Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Case API

4 actions 4 updates phrasing extends openapi/khoros-ai-case-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 4

$.info

$.paths['/case'].post

$.paths['/case/{id}'].get

$.paths['/case/{id}'].patch

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 Case API
  version: 1.0.0
extends: openapi/khoros-ai-case-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: 3
- target: $.paths['/case'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Care case with interactions
      effect: write
      questions:
      - How do I open a new case in Khoros Care from my own system?
      - Can a new case include its interactions and custom fields?
      instructions:
      - text: Create a case titled {title} with interactions {interactions}.
        slots:
          title: requestBody.title
          interactions: requestBody.interactions
      - text: Open a new Care case with custom ID {custom_id}.
        slots:
          custom_id: requestBody.customId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/case/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a Care case
      effect: read
      questions:
      - How do I fetch the details of one Care case by its ID?
      - What information comes back for an existing case?
      instructions:
      - text: Look up case {id}.
        slots:
          id: path.id
      - text: Show me Care case {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/case/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing Care case
      effect: write
      questions:
      - Can I change the title or add interactions to a case that already exists?
      - How do I update custom fields on a Care case?
      instructions:
      - text: Change the title of case {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Add interactions {interactions} to existing case {id}.
        slots:
          id: path.id
          interactions: requestBody.interactions
      method: generated
      generated: '2026-10-01'