Lucidya · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/lucidya-ltd-profiles-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 5

$.info
$.paths['/profiles'].get
$.paths['/profiles'].put
$.paths['/profiles'].post
$.paths['/profiles/{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 CDP (Customer Data Platform) Profiles API
  version: 1.0.0
extends: openapi/lucidya-ltd-profiles-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: 4
- target: $.paths['/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer profiles in a date range
      effect: read
      questions:
      - Which customer profile IDs exist in my CDP for a given period?
      - Can I page through the full list of customer profiles?
      instructions:
      - text: List customer profiles from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Get page {page} of profiles between {start_date} and {end_date}.
        slots:
          page: query.page
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profiles'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a customer profile's contact details
      effect: write
      questions:
      - Can I change the email or phone on an existing CDP profile?
      - What must I include when editing a customer profile?
      instructions:
      - text: Update profile {id} with {data}.
        slots:
          id: query.id
          data: requestBody.data
      - text: Change the contact details on existing profile {id} to {data}.
        slots:
          id: query.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new customer profile
      effect: write
      questions:
      - How do I add a brand-new customer profile to the CDP?
      - Does a new profile need a phone, email or social account to be created?
      instructions:
      - text: Create a new profile named {name} with {data}.
        slots:
          name: requestBody.name
          data: requestBody.data
      - text: Add a new CDP customer with contact data {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full details for one customer profile
      effect: read
      questions:
      - What has Lucidya analysed about a specific customer?
      - Can I pull everything gathered for one profile by its ID?
      instructions:
      - text: Get full profile details for customer {id}.
        slots:
          id: path.id
      - text: Show me everything known about profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'