Kit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kit Snippets API

5 actions 5 updates phrasing extends openapi/convertkit-snippets-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 5

$.info
$.paths['/v4/snippets'].get
$.paths['/v4/snippets'].post
$.paths['/v4/snippets/{id}'].get
$.paths['/v4/snippets/{id}'].put

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 Snippets API
  version: 1.0.0
extends: openapi/convertkit-snippets-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: 4
- target: $.paths['/v4/snippets'].get
  update:
    x-apievangelist-phrasing:
      intent: List reusable email snippets
      effect: read
      questions:
      - What reusable content snippets can I drop into my emails?
      - Can I list only archived snippets?
      - Which snippets are inline text versus rich-text blocks?
      instructions:
      - text: List my snippets of type {snippet_type}.
        slots:
          snippet_type: query.snippet_type
      - text: Show my archived snippets with archived set to {archived}.
        slots:
          archived: query.archived
      - text: List all my active snippets.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/snippets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reusable email snippet
      effect: write
      questions:
      - How do I create a snippet I can reuse across broadcasts and sequence emails?
      - Can I make a footer snippet that updates everywhere it's used?
      instructions:
      - text: Create a new reusable snippet for my email footer.
      - text: Make a new snippet I can insert into broadcasts with Liquid.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/snippets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one snippet with its content
      effect: read
      questions:
      - Can I fetch the full content of a single snippet?
      - What Liquid key does a particular snippet use?
      instructions:
      - text: Get snippet {id}.
        slots:
          id: path.id
      - text: Show me the full body of snippet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v4/snippets/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update, rename or archive a snippet
      effect: write
      questions:
      - How do I change the text of an existing snippet?
      - Can I archive or restore a snippet?
      instructions:
      - text: Update snippet {id}.
        slots:
          id: path.id
      - text: Archive existing snippet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'