Lucidya · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CDP (Customer Data Platform) Profile Interactions API

3 actions 3 updates phrasing extends openapi/lucidya-ltd-profile-interactions-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 3

$.info
$.paths['/profiles/interactions'].post
$.paths['/profiles/{id}/interactions'].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) Profile Interactions API
  version: 1.0.0
extends: openapi/lucidya-ltd-profile-interactions-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: 2
- target: $.paths['/profiles/interactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a job collecting a customer's interactions
      effect: write
      questions:
      - How do I gather every interaction a customer had with us over a period?
      - What date range and profile details does an interactions job need?
      instructions:
      - text: Create an interactions job for profile {profile_id} from {start_date} to {end_date}.
        slots:
          profile_id: query.profile_id
          start_date: query.start_date
          end_date: query.end_date
      - text: Start collecting interactions for customer {profile_id}.
        slots:
          profile_id: query.profile_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profiles/{id}/interactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer's public and private interactions
      effect: read
      questions:
      - Can I see all public and private social interactions for one customer?
      - Which job_id do I need to read a profile's interactions?
      instructions:
      - text: Get interactions for profile {id} using job {job_id}.
        slots:
          id: path.id
          job_id: query.job_id
      - text: Show customer {id}'s social interactions from job {job_id}.
        slots:
          id: path.id
          job_id: query.job_id
      method: generated
      generated: '2026-10-01'