Kit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kit API V4 Account API

6 actions 6 updates phrasing extends openapi/convertkit-account-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 6

$.info
$.paths['/account'].get
$.paths['/account/colors'].get
$.paths['/account/colors'].put
$.paths['/account/email_stats'].get
$.paths['/account/growth_stats'].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 API V4 Account API
  version: 1.0.0
extends: openapi/convertkit-account-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: 5
- target: $.paths['/account'].get
  update:
    x-apievangelist-phrasing:
      intent: View my Kit account and user details
      effect: read
      questions:
      - Which Kit account and user does my API key belong to?
      - Can I look up my account name and the signed-in user's email through the API?
      - What account details come back for the credentials I'm using?
      instructions:
      - text: Show me the account and user details for my Kit login.
      - text: Confirm which account my current API credentials are connected to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account/colors'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's saved brand colors
      effect: read
      questions:
      - What color preferences are saved on my email marketing account?
      - Can I see the brand colors configured for my Kit account?
      instructions:
      - text: List the color preferences currently configured on my account.
      - text: Show me my account's saved brand color palette.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account/colors'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the account's brand colors
      effect: write
      questions:
      - How do I change the saved brand colors on my account?
      - Can I replace my account's color preferences with a new palette?
      instructions:
      - text: Set my account's color preferences to {colors}.
        slots:
          colors: requestBody.colors
      - text: Replace my saved brand color palette with {colors}.
        slots:
          colors: requestBody.colors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account/email_stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get email performance stats for the last 90 days
      effect: read
      questions:
      - How have my emails performed over the last 90 days?
      - What do my account email stats look like across the past three months?
      - Is there an account-wide summary of email statistics I can pull?
      instructions:
      - text: Get my account's email statistics for the last 90 days.
      - text: Summarize how my sent emails performed over the past three months.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account/growth_stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get subscriber growth for a date range
      effect: read
      questions:
      - How many subscribers did I gain or lose over a given period?
      - Can I see my list growth between two specific dates?
      - What does my subscriber growth look like for last month?
      instructions:
      - text: Show my subscriber growth from {starting} to {ending}.
        slots:
          starting: query.starting
          ending: query.ending
      - text: Report how my audience grew since {starting}.
        slots:
          starting: query.starting
      - text: Get my current subscriber growth metrics.
      method: generated
      generated: '2026-09-26'