Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight PX REST K Cbot API

4 actions 4 updates phrasing extends openapi/gainsight-kcbot-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Gainsight's API. It is a proposal applied on top of the contract, not a document Gainsight publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/kcbot'].get
$.paths['/v1/kcbot/state'].put
$.paths['/v1/kcbot/{kcId}'].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 Gainsight PX REST K Cbot API
  version: 1.0.0
extends: openapi/gainsight-kcbot-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/kcbot'].get
  update:
    x-apievangelist-phrasing:
      intent: List Knowledge Center bots
      effect: read
      questions:
      - What Knowledge Center bots are set up in my subscription?
      - Can I list KC bots for one product only?
      instructions:
      - text: List KC bots for product {productId}.
        slots:
          productId: query.productId
      - text: Show all Knowledge Center bots, {pageSize} per page.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/kcbot/state'].put
  update:
    x-apievangelist-phrasing:
      intent: Start or pause a Knowledge Center bot
      effect: write
      questions:
      - How do I pause a Knowledge Center bot?
      - Can I start a KC bot only in certain environments?
      instructions:
      - text: Set KC bot {kcId} to state {state}.
        slots:
          kcId: requestBody.kcId
          state: requestBody.state
      - text: Start Knowledge Center {kcId} ({state}) in environments {envs}.
        slots:
          kcId: requestBody.kcId
          state: requestBody.state
          envs: requestBody.envs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/kcbot/{kcId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Knowledge Center bot
      effect: read
      questions:
      - How do I look up one KC bot's configuration?
      - Can I retrieve a Knowledge Center bot by ID?
      instructions:
      - text: Get KC bot {kcId}.
        slots:
          kcId: path.kcId
      - text: Show the Knowledge Center bot with ID {kcId}.
        slots:
          kcId: path.kcId
      method: generated
      generated: '2026-09-26'