Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Initiatives API

3 actions 3 updates phrasing extends openapi/khoros-ai-initiatives-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['/{environment}/v1/company/{companyId}/initiative'].get

$.paths['/{environment}/v1/company/{companyId}/initiative/{initiativeId}'].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 Initiatives API
  version: 1.0.0
extends: openapi/khoros-ai-initiatives-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['/{environment}/v1/company/{companyId}/initiative'].get
  update:
    x-apievangelist-phrasing:
      intent: List initiatives through the v1 company API
      effect: read
      questions:
      - How do I list a company's initiatives using the v1 environment path?
      - Can I filter v1 initiatives by name?
      instructions:
      - text: List initiatives for company {company} in {env}.
        slots:
          company: path.companyId
          env: path.environment
      - text: Find initiatives named {name} for company {company} on {env}.
        slots:
          name: query.nameFilter
          company: path.companyId
          env: path.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{environment}/v1/company/{companyId}/initiative/{initiativeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an initiative through the v1 company API
      effect: read
      questions:
      - How do I fetch one initiative by ID using the v1 company path?
      - What does a single v1 initiative record contain?
      instructions:
      - text: Get initiative {initiative} for company {company} in {env}.
        slots:
          initiative: path.initiativeId
          company: path.companyId
          env: path.environment
      - text: Show details of initiative {initiative} under company {company} on {env}.
        slots:
          initiative: path.initiativeId
          company: path.companyId
          env: path.environment
      method: generated
      generated: '2026-10-01'