# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for V1 Lytics Experience API
  version: 1.0.0
extends: openapi/lytics-experience-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: 26
- target: $.paths['/api/experience'].get
  update:
    x-apievangelist-phrasing:
      intent: List personalization experiences
      effect: read
      questions:
      - Which experiences do I have set up for personalization?
      - Can I include soft-deleted experiences in the list?
      - Can I filter experiences by the provider they run on?
      instructions:
      - text: List all my experiences.
      - text: 'Show experiences for provider {provider}, including deleted: {deleted}.'
        slots:
          provider: query.provider
          deleted: query.deleted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a personalization experience
      effect: write
      questions:
      - What fields are required to create a new experience, like label and tactic?
      - Can I set up a new experience through the API?
      instructions:
      - text: Create a new experience with a label, provider and tactic.
      - text: Set up a fresh personalization experience.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one experience
      effect: read
      questions:
      - Can I fetch one experience along with its templates and parent groups?
      - Can I still read an experience that was soft-deleted?
      instructions:
      - text: Show experience {id}.
        slots:
          id: path.id
      - text: 'Fetch experience {id} even if it was deleted: {deleted}.'
        slots:
          id: path.id
          deleted: query.deleted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an experience
      effect: destructive
      questions:
      - Is deleting an experience recoverable, or can I hard delete it?
      - Can I delete an experience along with everything downstream of it?
      instructions:
      - text: Delete experience {id}.
        slots:
          id: path.id
      - text: Delete experience {id} using method {method}, recursive {recursive}.
        slots:
          id: path.id
          method: query.method
          recursive: query.recursive
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an experience or change its state
      effect: write
      questions:
      - Can I change only the state of an experience, like pausing it?
      - How do I edit an existing experience?
      instructions:
      - text: Update experience {id}.
        slots:
          id: path.id
      - text: Change only the state of experience {id} (update_state {update_state}).
        slots:
          id: path.id
          update_state: query.update_state
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/import'].get
  update:
    x-apievangelist-phrasing:
      intent: List experiences importable from a provider
      effect: read
      questions:
      - Which existing campaigns can I import as experiences from a connected provider?
      - Can I hide experiences I've already imported from the import list?
      instructions:
      - text: Show importable experiences from provider {provider_slug} using auth {auth_id}.
        slots:
          provider_slug: query.provider_slug
          auth_id: query.auth_id
      - text: 'List what I can import from {provider_slug} with auth {auth_id}, including existing: {include_existing}.'
        slots:
          provider_slug: query.provider_slug
          auth_id: query.auth_id
          include_existing: query.include_existing
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import experiences from a provider
      effect: write
      questions:
      - Once I've listed importable experiences, how do I bring them in?
      - Can I import a batch of experiences from a third-party provider?
      instructions:
      - text: Import the selected experience records from the provider.
      - text: Create experiences from these import results.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/template'].get
  update:
    x-apievangelist-phrasing:
      intent: List experience templates
      effect: read
      questions:
      - Which experience templates are available to me?
      - Can I see all the templates I can build experiences from?
      instructions:
      - text: List my experience templates.
      - text: Show every available experience template.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/template'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an experience template
      effect: write
      questions:
      - Can I save a reusable template for future experiences?
      - What goes into a new experience template?
      instructions:
      - text: Create a new experience template.
      - text: Save this setup as an experience template.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/template/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an experience template
      effect: read
      questions:
      - Can I look at one experience template by id?
      - What does a particular template contain?
      instructions:
      - text: Show experience template {id}.
        slots:
          id: path.id
      - text: Fetch template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/template/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an experience template
      effect: destructive
      questions:
      - Can I remove an experience template I no longer use?
      - Is it possible to get rid of an old template?
      instructions:
      - text: Delete experience template {id}.
        slots:
          id: path.id
      - text: Remove template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/template/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an experience template
      effect: write
      questions:
      - Can I edit an existing experience template?
      - Is it possible to change a template after it's created?
      instructions:
      - text: Update experience template {id}.
        slots:
          id: path.id
      - text: Edit template {id} with new settings.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/candidate'].get
  update:
    x-apievangelist-phrasing:
      intent: List experience candidates
      effect: read
      questions:
      - Which experience candidates are available to my token?
      - Can I list all candidate experiences?
      instructions:
      - text: List my experience candidates.
      - text: Show all candidate experiences.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/preview/{accountid}/{id}/config.js'].get
  update:
    x-apievangelist-phrasing:
      intent: Get preview JavaScript for one web experience
      effect: read
      questions:
      - Can I get the Pathfora config to preview a single web experience?
      - How do I preview a web personalization before publishing it?
      instructions:
      - text: Get the preview config.js for experience {id} in account {accountid}.
        slots:
          id: path.id
          accountid: path.accountid
      - text: Render the Pathfora preview script for experience {id} on account {accountid}.
        slots:
          id: path.id
          accountid: path.accountid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/candidate/{accountid}/config.js'].get
  update:
    x-apievangelist-phrasing:
      intent: Get production JavaScript for published experiences
      effect: read
      questions:
      - Where do I get the JavaScript with all my published web experiences?
      - Can I pull the production Pathfora config for an account?
      instructions:
      - text: Get the production config.js for account {accountid}.
        slots:
          accountid: path.accountid
      - text: Render all published experience candidates as Pathfora config for {accountid}.
        slots:
          accountid: path.accountid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/group'].get
  update:
    x-apievangelist-phrasing:
      intent: List experience groups
      effect: read
      questions:
      - Which experience groups or journeys do I have?
      - Can I include deleted experience groups in the list?
      instructions:
      - text: List my experience groups.
      - text: 'Show up to {limit} experience groups, including deleted: {deleted}.'
        slots:
          limit: query.limit
          deleted: query.deleted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/group'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an experience group
      effect: write
      questions:
      - Can I group several experiences together under one label and class?
      - Can a new experience group contain nested groups?
      instructions:
      - text: Create a new experience group.
      - text: Set up an experience group nesting these experiences.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/group/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an experience group
      effect: read
      questions:
      - Can I fetch one experience group by id?
      - What experiences sit inside a particular group?
      instructions:
      - text: Show experience group {id}.
        slots:
          id: path.id
      - text: 'Fetch group {id}, including deleted: {deleted}.'
        slots:
          id: path.id
          deleted: query.deleted
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/group/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an experience group
      effect: destructive
      questions:
      - Can I delete an experience group and everything nested inside it?
      - Is a deleted experience group recoverable?
      instructions:
      - text: Delete experience group {id}.
        slots:
          id: path.id
      - text: Delete group {id} with method {method}, recursive {recursive}.
        slots:
          id: path.id
          method: query.method
          recursive: query.recursive
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/group/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an experience group
      effect: write
      questions:
      - Can I change which experiences belong to a group?
      - Is it possible to rename or edit an experience group?
      instructions:
      - text: Update experience group {id}.
        slots:
          id: path.id
      - text: Change the nested experiences in group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/prioritization'].get
  update:
    x-apievangelist-phrasing:
      intent: List experience prioritizations
      effect: read
      questions:
      - Which prioritization records control the order experiences show in?
      - Can I list all prioritization records?
      instructions:
      - text: List my experience prioritizations.
      - text: Show every prioritization record.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/prioritization'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an experience prioritization
      effect: write
      questions:
      - Can I set a priority order for competing experiences?
      - What's needed to create a prioritization record?
      instructions:
      - text: Create a new prioritization record.
      - text: Set up a priority order for my experiences.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/prioritization/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an experience prioritization
      effect: read
      questions:
      - Can I look at one prioritization record?
      - What order does a specific prioritization define?
      instructions:
      - text: Show prioritization {id}.
        slots:
          id: path.id
      - text: Fetch prioritization record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/prioritization/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an experience prioritization
      effect: destructive
      questions:
      - Can I remove a prioritization record?
      - Can I hard delete a prioritization instead of soft deleting it?
      instructions:
      - text: Delete prioritization {id}.
        slots:
          id: path.id
      - text: Delete prioritization {id} using method {method}.
        slots:
          id: path.id
          method: query.method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/prioritization/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an experience prioritization
      effect: write
      questions:
      - Can I change the order in an existing prioritization?
      - Is it possible to edit a prioritization record?
      instructions:
      - text: Update prioritization {id}.
        slots:
          id: path.id
      - text: Reorder the experiences in prioritization {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/experience/group/priority'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the top-level journey priority
      effect: write
      questions:
      - Can I set the overall priority order of my journeys?
      - Where is the account-wide journey hierarchy managed?
      instructions:
      - text: Update the master journey priority for my account.
      - text: Reorder my top-level journeys.
      method: generated
      generated: '2026-10-01'