API Evangelist conversational phrasing for Klaviyo Segments API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klaviyo Segments API
  version: 1.0.0
extends: openapi/klaviyo-segments-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: 11
- target: $.paths['/api/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List segments in the account
      effect: read
      questions:
      - What audience segments have I built in Klaviyo?
      - Can I filter segments by name or when they were created?
      instructions:
      - text: List all my segments.
      - text: Find segments matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segment
      effect: write
      questions:
      - How do I build a new audience segment from a set of conditions?
      - What do I pass to define a segment's rules?
      instructions:
      - text: 'Create a segment with this definition: {segment}.'
        slots:
          segment: requestBody.data
      - text: Build a new segment of customers matching {segment}.
        slots:
          segment: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one segment by ID
      effect: read
      questions:
      - How many profiles are in a particular segment?
      - Can I see a segment's definition by its ID?
      instructions:
      - text: Get segment {segment_id}.
        slots:
          segment_id: path.id
      - text: Show segment {segment_id} with {additional_fields}.
        slots:
          segment_id: path.id
          additional_fields: query.additional-fields[segment]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a segment
      effect: destructive
      questions:
      - How do I remove a segment I don't need anymore?
      - Can I delete a segment by its ID?
      instructions:
      - text: Delete segment {segment_id}.
        slots:
          segment_id: path.id
      - text: Remove the unused segment {segment_id}.
        slots:
          segment_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a segment's name or rules
      effect: write
      questions:
      - Can I change the conditions of an existing segment?
      - What's the way to rename a segment?
      instructions:
      - text: Update segment {segment_id} with {changes}.
        slots:
          segment_id: path.id
          changes: requestBody.data
      - text: Change the conditions of segment {segment_id} to {changes}.
        slots:
          segment_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments/{id}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List a segment's tags
      effect: read
      questions:
      - What tags are on a particular segment?
      - Can I get full tag records for one segment?
      instructions:
      - text: List the tags on segment {segment_id}.
        slots:
          segment_id: path.id
      - text: Show full tag details for segment {segment_id}.
        slots:
          segment_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments/{id}/relationships/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tag IDs for a segment
      effect: read
      questions:
      - Can I fetch only the tag IDs on a segment?
      - What tag relationships does a segment have?
      instructions:
      - text: Get just the tag IDs for segment {segment_id}.
        slots:
          segment_id: path.id
      - text: Return tag relationships of segment {segment_id}.
        slots:
          segment_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments/{id}/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List the profiles in a segment
      effect: read
      questions:
      - Who is currently in a given segment?
      - Can I filter a segment's members by email or the date they joined?
      instructions:
      - text: List the profiles in segment {segment_id}.
        slots:
          segment_id: path.id
      - text: Show members of segment {segment_id} matching {filter}.
        slots:
          segment_id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments/{id}/relationships/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: Get profile IDs in a segment
      effect: read
      questions:
      - Can I get only the profile IDs of a segment's members?
      - What's the lightweight way to export membership IDs for a segment?
      instructions:
      - text: Get just the profile IDs in segment {segment_id}.
        slots:
          segment_id: path.id
      - text: Return profile relationships of segment {segment_id}.
        slots:
          segment_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments/{id}/flow-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List flows triggered by a segment
      effect: read
      questions:
      - Which flows start when someone joins a given segment?
      - Can I see full flow records for automations a segment triggers?
      instructions:
      - text: List flows triggered by segment {segment_id}.
        slots:
          segment_id: path.id
      - text: Show full flow details for automations started by segment {segment_id}.
        slots:
          segment_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segments/{id}/relationships/flow-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get IDs of flows a segment triggers
      effect: read
      questions:
      - Can I get only the flow IDs that use a segment as their trigger?
      - What flow-trigger relationships does a segment have?
      instructions:
      - text: Get just the flow IDs triggered by segment {segment_id}.
        slots:
          segment_id: path.id
      - text: Return flow-trigger relationships of segment {segment_id}.
        slots:
          segment_id: path.id
      method: generated
      generated: '2026-09-26'