Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Folder API

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

$.info
$.paths['/{environment}/v1/company/{companyId}/folder'].get
$.paths['/{environment}/v1/company/{companyId}/folder'].post
$.paths['/{environment}/v1/company/{companyId}/folder/{folderId}'].get
$.paths['/{environment}/v1/company/{companyId}/folder/{folderId}'].put
$.paths['/{environment}/v1/company/{companyId}/folder/{folderId}'].delete
$.paths['/{environment}/v1/company/{companyId}/folder/{folderId}/assets'].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 Folder API
  version: 1.0.0
extends: openapi/khoros-ai-folder-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: 6
- target: $.paths['/{environment}/v1/company/{companyId}/folder'].get
  update:
    x-apievangelist-phrasing:
      intent: List Content Center folders
      effect: read
      questions:
      - What folders do we have in Content Center?
      - Can I filter Content Center folders by name and page through them?
      instructions:
      - text: List Content Center folders for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
      - text: Find folders named like {nameFilter} for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          nameFilter: query.nameFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{environment}/v1/company/{companyId}/folder'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Content Center asset folder
      effect: write
      questions:
      - How do I make a new folder to organize Content Center assets?
      - Can I give a new asset folder a description?
      instructions:
      - text: Create a Content Center folder called {name} for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          name: requestBody.name
      - text: Add a new asset folder {name} described as {description} in company {companyId} ({environment}).
        slots:
          environment: path.environment
          companyId: path.companyId
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{environment}/v1/company/{companyId}/folder/{folderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Content Center folder by ID
      effect: read
      questions:
      - How do I look up one Content Center folder's details by its ID?
      - Which details does a single asset folder record include?
      instructions:
      - text: Get folder {folderId} for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          folderId: path.folderId
      - text: Show me the details of asset folder {folderId} (company {companyId}, {environment}).
        slots:
          environment: path.environment
          companyId: path.companyId
          folderId: path.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{environment}/v1/company/{companyId}/folder/{folderId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or update a Content Center folder
      effect: write
      questions:
      - Can I rename an existing Content Center folder?
      - How do I change an asset folder's description?
      instructions:
      - text: Rename folder {folderId} to {name} for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          folderId: path.folderId
          name: requestBody.name
      - text: Update the description of folder {folderId} to {description} in company {companyId}, {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          folderId: path.folderId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{environment}/v1/company/{companyId}/folder/{folderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Content Center folder
      effect: destructive
      questions:
      - How do I delete an asset folder I no longer need?
      - Can I remove a Content Center folder by its ID?
      instructions:
      - text: Delete folder {folderId} from company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          folderId: path.folderId
      - text: Remove Content Center folder {folderId} for {companyId} ({environment}).
        slots:
          environment: path.environment
          companyId: path.companyId
          folderId: path.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{environment}/v1/company/{companyId}/folder/{folderId}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the assets inside a folder
      effect: read
      questions:
      - What assets are stored in a particular Content Center folder?
      - Can I sort a folder's assets and page through them?
      instructions:
      - text: List assets in folder {folderId} for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          folderId: path.folderId
      - text: Show assets in folder {folderId} ordered by {orderBy} {direction} for company {companyId}, {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          folderId: path.folderId
          orderBy: query.orderBy
          direction: query.direction
      method: generated
      generated: '2026-10-01'