Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Flows API

21 actions 21 updates phrasing extends openapi/klaviyo-flows-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 21 · first 16 shown; the file carries all of them

$.info
$.paths['/api/flows'].get
$.paths['/api/flows'].post
$.paths['/api/flows/{id}'].get
$.paths['/api/flows/{id}'].delete
$.paths['/api/flows/{id}'].patch
$.paths['/api/flow-actions/{id}'].get
$.paths['/api/flow-actions/{id}'].patch
$.paths['/api/flow-messages/{id}'].get
$.paths['/api/flows/{id}/flow-actions'].get
$.paths['/api/flows/{id}/relationships/flow-actions'].get
$.paths['/api/flows/{id}/tags'].get
$.paths['/api/flows/{id}/relationships/tags'].get
$.paths['/api/flow-actions/{id}/flow'].get
$.paths['/api/flow-actions/{id}/relationships/flow'].get
$.paths['/api/flow-actions/{id}/flow-messages'].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 Flows API
  version: 1.0.0
extends: openapi/klaviyo-flows-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: 20
- target: $.paths['/api/flows'].get
  update:
    x-apievangelist-phrasing:
      intent: List automated flows
      effect: read
      questions:
      - What automated flows do I have in Klaviyo?
      - Can I list only my live flows?
      - Which flows were updated most recently?
      instructions:
      - text: List flows matching {filter}.
        slots:
          filter: query.filter
      - text: Show all flows sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a flow from a definition
      effect: write
      questions:
      - How do I build a new automated flow through the API?
      - Can I create a flow with its actions from an encoded definition?
      instructions:
      - text: Create a flow from definition {definition}.
        slots:
          definition: requestBody.data
      - text: Build a new automation flow using {definition}.
        slots:
          definition: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flows/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one flow
      effect: read
      questions:
      - What are the details and status of a specific flow?
      - Can I fetch a flow's full definition?
      instructions:
      - text: Get flow {flow_id}.
        slots:
          flow_id: path.id
      - text: Show the definition and status of flow {flow_id}.
        slots:
          flow_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flows/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a flow
      effect: destructive
      questions:
      - Can I permanently delete an automated flow?
      - What's the way to remove a flow I no longer need?
      instructions:
      - text: Delete flow {flow_id}.
        slots:
          flow_id: path.id
      - text: Permanently remove flow {flow_id}.
        slots:
          flow_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flows/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a flow's status
      effect: write
      questions:
      - How do I turn a flow live or put it back in draft?
      - Does changing a flow's status also change its actions?
      instructions:
      - text: Set the status of flow {flow_id} to {status}.
        slots:
          flow_id: path.id
          status: requestBody.data
      - text: Change the status of flow {flow_id} and all its actions to {status}.
        slots:
          flow_id: path.id
          status: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-actions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one flow action
      effect: read
      questions:
      - What does a specific step in my flow do?
      - Can I look up a single flow action by ID?
      instructions:
      - text: Get flow action {action_id}.
        slots:
          action_id: path.id
      - text: Show the settings of flow step {action_id}.
        slots:
          action_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-actions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a flow action
      effect: write
      questions:
      - Can I change the settings of one step in a flow?
      - How do I edit a single flow action?
      instructions:
      - text: Update flow action {action_id} with {changes}.
        slots:
          action_id: path.id
          changes: requestBody.data
      - text: Change flow step {action_id} to {changes}.
        slots:
          action_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-messages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one flow message
      effect: read
      questions:
      - What's in a specific email or SMS message within a flow?
      - Can I fetch a flow message by its ID?
      instructions:
      - text: Get flow message {message_id}.
        slots:
          message_id: path.id
      - text: Show the content of flow message {message_id}.
        slots:
          message_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flows/{id}/flow-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the actions in a flow
      effect: read
      questions:
      - What steps make up a particular flow?
      - Can I see full details of every action in one flow?
      instructions:
      - text: List the actions in flow {flow_id}.
        slots:
          flow_id: path.id
      - text: Show every step of flow {flow_id} with its details.
        slots:
          flow_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flows/{id}/relationships/flow-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List action IDs for a flow
      effect: read
      questions:
      - Can I get only the action IDs for one flow?
      - Which action IDs belong to a flow?
      instructions:
      - text: Get only the action IDs in flow {flow_id}.
        slots:
          flow_id: path.id
      - text: Return the action ID list for flow {flow_id}.
        slots:
          flow_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flows/{id}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tags on a flow
      effect: read
      questions:
      - What tags are applied to a specific flow?
      - Can I see the tag names on one flow?
      instructions:
      - text: List the tags on flow {flow_id}.
        slots:
          flow_id: path.id
      - text: Show tag names applied to flow {flow_id}.
        slots:
          flow_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flows/{id}/relationships/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tag IDs on a flow
      effect: read
      questions:
      - Can I get just the tag IDs attached to a flow?
      - Which tag IDs does one flow carry?
      instructions:
      - text: Get only the tag IDs on flow {flow_id}.
        slots:
          flow_id: path.id
      - text: Return the tag ID list for flow {flow_id}.
        slots:
          flow_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-actions/{id}/flow'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the flow a flow action belongs to
      effect: read
      questions:
      - Which flow does a given action belong to?
      - Can I get the full parent flow from an action ID?
      instructions:
      - text: Get the flow that contains action {action_id}.
        slots:
          action_id: path.id
      - text: Show the parent flow details for step {action_id}.
        slots:
          action_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-actions/{id}/relationships/flow'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the flow ID for a flow action
      effect: read
      questions:
      - Can I get only the parent flow ID for an action?
      - What's the flow ID behind a given step?
      instructions:
      - text: Get only the flow ID for action {action_id}.
        slots:
          action_id: path.id
      - text: Return the parent flow ID of step {action_id}.
        slots:
          action_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-actions/{id}/flow-messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List the messages in a flow action
      effect: read
      questions:
      - What messages does a particular flow step send?
      - Can I see full message details for one flow action?
      instructions:
      - text: List the messages for flow action {action_id}.
        slots:
          action_id: path.id
      - text: Show every message sent by step {action_id}.
        slots:
          action_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-actions/{id}/relationships/flow-messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List message IDs for a flow action
      effect: read
      questions:
      - Can I get only the message IDs for a flow action?
      - Which message IDs belong to one flow step?
      instructions:
      - text: Get only the message IDs for flow action {action_id}.
        slots:
          action_id: path.id
      - text: Return the message ID list for step {action_id}.
        slots:
          action_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-messages/{id}/flow-action'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the flow action behind a message
      effect: read
      questions:
      - Which flow step sends a particular message?
      - Can I get full action details from a message ID?
      instructions:
      - text: Get the flow action for message {message_id}.
        slots:
          message_id: path.id
      - text: Show the step that sends flow message {message_id}.
        slots:
          message_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-messages/{id}/relationships/flow-action'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the flow action ID for a message
      effect: read
      questions:
      - Can I get just the action ID for a flow message?
      - What's the action ID behind one message?
      instructions:
      - text: Look up just the step ID behind flow message {message_id}.
        slots:
          message_id: path.id
      - text: Return the action identifier that owns message {message_id}.
        slots:
          message_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-messages/{id}/template'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the template used by a flow message
      effect: read
      questions:
      - Which email template does a flow message use?
      - Can I see the full template content behind a flow message?
      instructions:
      - text: Get the template for flow message {message_id}.
        slots:
          message_id: path.id
      - text: Show the template content used by message {message_id}.
        slots:
          message_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-messages/{id}/relationships/template'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the template ID for a flow message
      effect: read
      questions:
      - Can I get only the template ID for a flow message?
      - What's the template ID attached to a message in my flow?
      instructions:
      - text: Get only the template ID for flow message {message_id}.
        slots:
          message_id: path.id
      - text: Return the template ID behind message {message_id}.
        slots:
          message_id: path.id
      method: generated
      generated: '2026-09-26'