Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Accounts API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/accounts'].get
$.paths['/api/accounts/{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 Klaviyo Accounts API
  version: 1.0.0
extends: openapi/klaviyo-accounts-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: 2
- target: $.paths['/api/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the account for this API key
      effect: read
      questions:
      - How can I check that my private API key works and which account it belongs to?
      - What timezone and currency is my Klaviyo account set to?
      instructions:
      - text: Show the account tied to my API key.
      - text: Get my account's contact info and timezone using API revision {revision}.
        slots:
          revision: header.revision
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account by its ID
      effect: read
      questions:
      - Can I fetch account details when I already know the account ID?
      - Why can I only look up the account my key was generated for?
      instructions:
      - text: Get account {account_id}.
        slots:
          account_id: path.id
      - text: Show the public API key and settings for account {account_id}.
        slots:
          account_id: path.id
      method: generated
      generated: '2026-09-26'