Knock · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knock Management API (mAPI) API keys API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v1/api_keys/exchange'].post

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 Knock Management API (mAPI) API keys API
  version: 1.0.0
extends: openapi/knock-app-api-keys-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/api_keys/exchange'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a service token for an API key
      effect: write
      questions:
      - How do I turn a Knock service token into a secret API key for one environment?
      - Can a service token get me a key that works against the public API?
      instructions:
      - text: Exchange my service token for a secret API key in {environment}.
        slots:
          environment: query.environment
      - text: Get a public API secret key for the {environment} environment.
        slots:
          environment: query.environment
      method: generated
      generated: '2026-10-01'