Kit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kit Posts API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v4/posts'].get
$.paths['/v4/posts/{id}'].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 Kit Posts API
  version: 1.0.0
extends: openapi/convertkit-posts-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: 2
- target: $.paths['/v4/posts'].get
  update:
    x-apievangelist-phrasing:
      intent: List published newsletter posts
      effect: read
      questions:
      - Which posts are published on my newsletter's web archive?
      - Can I include the full post content when listing posts?
      instructions:
      - text: List all my published posts.
      - text: List my posts with the content included set to {include_content}.
        slots:
          include_content: query.include_content
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/posts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single post
      effect: read
      questions:
      - How do I fetch one specific newsletter post by its id?
      - Can I read the title and body of a single web post?
      instructions:
      - text: Get post {id}.
        slots:
          id: path.id
      - text: Show me the full details of web post {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'