Lucidya · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CDP (Customer Data Platform) Segments API

4 actions 4 updates phrasing extends openapi/lucidya-ltd-segments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Lucidya's API. It is a proposal applied on top of the contract, not a document Lucidya publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/segments'].get

$.paths['/segments/append_profiles'].put

$.paths['/segments/delete_profiles'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CDP (Customer Data Platform) Segments API
  version: 1.0.0
extends: openapi/lucidya-ltd-segments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer segments
      effect: read
      questions:
      - Which customer segments exist in my account?
      - Can I sort segments by how many profiles they hold?
      instructions:
      - text: List my segments sorted by {sort_by} in {order_by} order.
        slots:
          sort_by: query.sort_by
          order_by: query.order_by
      - text: Get page {page} of my customer segments.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments/append_profiles'].put
  update:
    x-apievangelist-phrasing:
      intent: Add profiles to a segment
      effect: write
      questions:
      - How do I add several customer profiles to an existing segment?
      - Can I append profiles to a segment using a comma-separated ID list?
      instructions:
      - text: Add profiles {profiles_ids} to segment {segment_id}.
        slots:
          profiles_ids: query.profiles_ids
          segment_id: query.segment_id
      - text: Append customer {profiles_ids} into segment {segment_id}.
        slots:
          profiles_ids: query.profiles_ids
          segment_id: query.segment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments/delete_profiles'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove profiles from a segment
      effect: destructive
      questions:
      - How do I take customers out of a segment?
      - Can I remove multiple profiles from a segment at once?
      instructions:
      - text: Remove profiles {profiles_ids} from segment {segment_id}.
        slots:
          profiles_ids: query.profiles_ids
          segment_id: query.segment_id
      - text: Delete customer {profiles_ids} from segment {segment_id}.
        slots:
          profiles_ids: query.profiles_ids
          segment_id: query.segment_id
      method: generated
      generated: '2026-10-01'