Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Requests API

3 actions 3 updates phrasing extends openapi/khoros-ai-requests-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['/requests'].post

$.paths['/requests/{requestUUID}'].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 Requests API
  version: 1.0.0
extends: openapi/khoros-ai-requests-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['/requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a GDPR erasure request for an author
      effect: write
      questions:
      - How do I handle a GDPR deletion request for a customer in Khoros Care?
      - Can a GDPR request also delete our brand's replies to that customer?
      instructions:
      - text: Create a GDPR request for author {author}.
        slots:
          author: requestBody.authorUUID
      - text: File a GDPR request for author {author} including brand responses.
        slots:
          author: requestBody.authorUUID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/requests/{requestUUID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a GDPR request's status
      effect: read
      questions:
      - How do I find out whether a GDPR request has finished?
      - What is the status of a GDPR request I submitted?
      instructions:
      - text: Check the status of GDPR request {request}.
        slots:
          request: path.requestUUID
      - text: Tell me whether GDPR request {request} is complete.
        slots:
          request: path.requestUUID
      method: generated
      generated: '2026-10-01'