Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Admin API

3 actions 3 updates phrasing extends openapi/khoros-ai-admin-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['/admin/custom'].post
$.paths['/admin/custom/{crmId}'].patch

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 Admin API
  version: 1.0.0
extends: openapi/khoros-ai-admin-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['/admin/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a custom CRM
      effect: write
      questions:
      - How do I connect our own CRM to Khoros?
      - What details are needed to register a custom CRM?
      instructions:
      - text: Register a custom CRM named {name} at {instanceUrl}.
        slots:
          name: requestBody.name
          instanceUrl: requestBody.instanceUrl
      - text: Add custom CRM {name} using auth header {authHeaderValue}.
        slots:
          name: requestBody.name
          authHeaderValue: requestBody.authHeaderValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/custom/{crmId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a registered custom CRM
      effect: write
      questions:
      - Can I change the URL or credentials of a custom CRM I already registered?
      - How do I edit an existing custom CRM registration?
      instructions:
      - text: Update custom CRM {crmId} to point at {instanceUrl}.
        slots:
          crmId: path.crmId
          instanceUrl: requestBody.instanceUrl
      - text: Rotate the auth header on CRM {crmId} to {authHeaderValue}.
        slots:
          crmId: path.crmId
          authHeaderValue: requestBody.authHeaderValue
      method: generated
      generated: '2026-10-01'