IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One Knowledge API

2 actions 2 updates phrasing extends openapi/integration-os-knowledge-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for IntegrationOS's API. It is a proposal applied on top of the contract, not a document IntegrationOS publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/knowledge'].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 One Knowledge API
  version: 1.0.0
extends: openapi/integration-os-knowledge-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: 1
- target: $.paths['/v1/knowledge'].get
  update:
    x-apievangelist-phrasing:
      intent: List action knowledge documents
      effect: read
      questions:
      - What per-action context does One use to ground LLM calls?
      - Can I see the knowledge documents for just one platform's actions?
      - Is there a way to pull the knowledge entry for a single action by its id?
      instructions:
      - text: List knowledge documents for the {platform} platform.
        slots:
          platform: query.connectionPlatform
      - text: Get the knowledge document for action {action_id}.
        slots:
          action_id: query._id
      - text: Show page {page} of the action knowledge library.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'