Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Broadcast API

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

$.info
$.paths['/broadcast/instant'].post
$.paths['/broadcast/instant/segment'].post
$.paths['/broadcast/segments'].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 Broadcast API
  version: 1.0.0
extends: openapi/khoros-ai-broadcast-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: 3
- target: $.paths['/broadcast/instant'].post
  update:
    x-apievangelist-phrasing:
      intent: Broadcast a message to phone numbers
      effect: write
      questions:
      - How do I send a broadcast to specific mobile numbers?
      - Can I choose the channel when broadcasting to an MSISDN?
      instructions:
      - text: Broadcast {payload} to the numbers in {audience}.
        slots:
          payload: requestBody.payload
          audience: requestBody.audience
      - text: Send an instant message to MSISDN audience {audience} on channel {channel}.
        slots:
          audience: requestBody.audience
          channel: requestBody.channel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/broadcast/instant/segment'].post
  update:
    x-apievangelist-phrasing:
      intent: Broadcast a message to audience segments
      effect: write
      questions:
      - How do I send a broadcast to a whole audience segment?
      - Can I message a saved segment instead of individual numbers?
      instructions:
      - text: Broadcast {payload} to segment {audience}.
        slots:
          payload: requestBody.payload
          audience: requestBody.audience
      - text: Send an instant broadcast to the segments in {audience}.
        slots:
          audience: requestBody.audience
      method: generated
      generated: '2026-10-01'
- target: $.paths['/broadcast/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List audience segments
      effect: read
      questions:
      - Which audience segments can I broadcast to?
      - Can I fetch segments synchronously?
      instructions:
      - text: List my audience segments.
      - text: Retrieve audience segments with sync set to {sync}.
        slots:
          sync: query.sync
      method: generated
      generated: '2026-10-01'