Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Assets API

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

$.info
$.paths['/{environment}/v1/company/{companyId}/asset'].post
$.paths['/{environment}/v1/company/{companyId}/asset?multipart'].post
$.paths['/{environment}/v1/company/{companyId}/asset/{assetId}'].get
$.paths['/{environment}/v1/company/{companyId}/asset/{assetId}'].put

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 Assets API
  version: 1.0.0
extends: openapi/khoros-ai-assets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/{environment}/v1/company/{companyId}/asset'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Content Center asset
      effect: write
      questions:
      - How do I create a Content Center asset record with a name, folder and entity type?
      - Can I set start and end dates on a new asset?
      instructions:
      - text: Create asset {name} in folder {folderId} for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          name: requestBody.name
          folderId: requestBody.folderId
      - text: Add asset {name} to folder {folderId} running {startDate} to {endDate} for {companyId}, {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          name: requestBody.name
          folderId: requestBody.folderId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-10-02'
- target: $.paths['/{environment}/v1/company/{companyId}/asset?multipart'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a Content Center asset with a media file
      effect: write
      questions:
      - How do I upload an image or video file as a new asset in one request?
      - Can I send the video file and asset details as multipart form data?
      instructions:
      - text: Upload image {image} as a new asset for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          image: requestBody.image
      - text: Upload video {video} with asset details {asset} for company {companyId} ({environment}).
        slots:
          environment: path.environment
          companyId: path.companyId
          video: requestBody.video
          asset: requestBody.asset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{environment}/v1/company/{companyId}/asset/{assetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Content Center asset by ID
      effect: read
      questions:
      - How do I look up a Content Center asset and its content labels?
      - Can I retrieve one asset's details by ID?
      instructions:
      - text: Get asset {assetId} for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          assetId: path.assetId
      - text: Show the content labels on asset {assetId} (company {companyId}, {environment}).
        slots:
          environment: path.environment
          companyId: path.companyId
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{environment}/v1/company/{companyId}/asset/{assetId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Content Center asset
      effect: write
      questions:
      - Can I move an asset to another folder or rename it?
      - How do I remove the image or video from an existing asset?
      instructions:
      - text: Rename asset {assetId} to {name} in folder {folderId} for company {companyId}, {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          assetId: path.assetId
          name: requestBody.name
          folderId: requestBody.folderId
      - text: Remove the video from asset {assetId} for company {companyId} in {environment}.
        slots:
          environment: path.environment
          companyId: path.companyId
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'