Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Images API

6 actions 6 updates phrasing extends openapi/klaviyo-images-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 6

$.info
$.paths['/api/images'].get
$.paths['/api/images'].post
$.paths['/api/images/{id}'].get
$.paths['/api/images/{id}'].patch
$.paths['/api/image-upload'].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 Klaviyo Images API
  version: 1.0.0
extends: openapi/klaviyo-images-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['/api/images'].get
  update:
    x-apievangelist-phrasing:
      intent: List images in the asset library
      effect: read
      questions:
      - What images are in my Klaviyo asset library?
      - Can I filter images by name or format?
      instructions:
      - text: List all images in my account.
      - text: Show images matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/images'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an image from a URL
      effect: write
      questions:
      - Can I add an image to my library by pointing at a web address?
      - Does image import accept a data URI instead of a link?
      instructions:
      - text: Import the image at {image_url} into my library.
        slots:
          image_url: requestBody.data
      - text: Add an image from the data URI {image_url}.
        slots:
          image_url: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/images/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one image by ID
      effect: read
      questions:
      - How do I get the hosted URL of a specific image?
      - Can I look up an image's details by its ID?
      instructions:
      - text: Get image {image_id}.
        slots:
          image_id: path.id
      - text: Show the hosted URL and details of image {image_id}.
        slots:
          image_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/images/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or hide an image
      effect: write
      questions:
      - Can I rename an image already in my library?
      - How do I hide an image from the asset library without deleting it?
      instructions:
      - text: Update image {image_id} with {changes}.
        slots:
          image_id: path.id
          changes: requestBody.data
      - text: 'Hide image {image_id} from the asset library: {changes}.'
        slots:
          image_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/image-upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an image file
      effect: write
      questions:
      - How do I upload a PNG or JPEG from my computer?
      - Which image formats and sizes are allowed for file uploads?
      instructions:
      - text: Upload the image file {file}.
        slots:
          file: requestBody.file
      - text: Upload {file} and name it {name}.
        slots:
          file: requestBody.file
          name: requestBody.name
      - text: Upload {file} as a hidden image set to {hidden}.
        slots:
          file: requestBody.file
          hidden: requestBody.hidden
      method: generated
      generated: '2026-09-26'