Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Author Api V2 API

6 actions 6 updates phrasing extends openapi/khoros-ai-author-api-v2-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 6

$.info
$.paths['/{lswUuid}'].get
$.paths['/{lswUuid}'].put
$.paths['/'].put
$.paths['/'].post
$.paths['/#'].get

OpenAPI Overlay

Raw ↑
# 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 Author Api V2 API
  version: 1.0.0
extends: openapi/khoros-ai-author-api-v2-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: 5
- target: $.paths['/{lswUuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Care author's details
      effect: read
      questions:
      - How do I look up a customer author's profile in Khoros Care?
      - Can I still see an author whose CRM entry was deleted?
      instructions:
      - text: Get details for Care author {author}.
        slots:
          author: path.lswUuid
      - text: Show author {author} even if their CRM entry is deleted.
        slots:
          author: path.lswUuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{lswUuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or merge a Care author's handles
      effect: write
      questions:
      - Can I merge social handles into one existing Care author?
      - How do I update attributes on a specific Care author?
      instructions:
      - text: Update Care author {author} with attributes {attributes}.
        slots:
          author: path.lswUuid
          attributes: requestBody.RAW_BODY
      - text: Merge these handles {attributes} into author {author}.
        slots:
          author: path.lswUuid
          attributes: requestBody.RAW_BODY
      method: generated
      generated: '2026-10-01'
- target: $.paths['/'].put
  update:
    x-apievangelist-phrasing:
      intent: Batch update records for one author
      effect: write
      questions:
      - Can I update several author records belonging to the same person in one call?
      - How do I batch edit all the records linked to a single author?
      instructions:
      - text: Batch update all records for this author.
      - text: Apply a batch update to every record tied to one author.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Care author from a CRM record
      effect: write
      questions:
      - How do I add a new author to Care and join it to a CRM record?
      - Can I map a custom CRM attribute when creating an author?
      instructions:
      - text: Create a Care author for CRM ID {crm_id}.
        slots:
          crm_id: requestBody.id
      - text: Add author {crm_id} from CRM instance {instance} to Care.
        slots:
          crm_id: requestBody.id
          instance: requestBody.networkinstance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/#'].get
  update:
    x-apievangelist-phrasing:
      intent: List Care authors page by page
      effect: read
      questions:
      - How do I page through every customer author in Khoros Care?
      - Can the author list include people whose CRM record was deleted?
      instructions:
      - text: List all Care authors.
      - text: List Care authors starting at offset {offset}, including deleted CRM entries.
        slots:
          offset: query.offset
      method: generated
      generated: '2026-10-01'