# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lytics Flows API
  version: 1.0.0
extends: openapi/lytics-flows-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/flow'].get
  update:
    x-apievangelist-phrasing:
      intent: List all flows and their versions
      effect: read
      questions:
      - Which journey flows exist on my account?
      - Can I list only the latest version of each flow?
      instructions:
      - text: List all my flows with every version.
      - text: List my flows with latest set to {latest}.
        slots:
          latest: query.latest
      method: generated
      generated: '2026-10-02'
- target: $.paths['/flow'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a flow by id in the body
      effect: write
      questions:
      - How do I create a new customer journey flow with an entry segment?
      - Can I upsert a flow when its id is only in the request body?
      instructions:
      - text: Create flow {id} labelled {label} entering from segment {entry_segment_id}.
        slots:
          id: requestBody.id
          label: requestBody.label
          entry_segment_id: requestBody.entry_segment_id
      - text: Save flow {id} with steps {steps} and root step {root_step_id}.
        slots:
          id: requestBody.id
          steps: requestBody.steps
          root_step_id: requestBody.root_step_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/flow/state'].get
  update:
    x-apievangelist-phrasing:
      intent: List possible flow state values
      effect: read
      questions:
      - What step slugs and personalization keys can flows produce on my account?
      - Which flow state values are available to personalize against?
      instructions:
      - text: List every possible flow state value.
      - text: Show the flow step slugs and personalization keys for account {account_id}.
        slots:
          account_id: query.account_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/flow/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a flow by name
      effect: read
      questions:
      - Can I fetch a single flow and all its versions by its name?
      - What does the newest version of a named flow look like?
      instructions:
      - text: Show flow {name} with all its versions.
        slots:
          name: path.name
      - text: Get flow {name} with latest set to {latest}.
        slots:
          name: path.name
          latest: query.latest
      method: generated
      generated: '2026-10-02'
- target: $.paths['/flow/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a flow addressed by name
      effect: write
      questions:
      - Can I save a flow using its name in the URL as the id?
      - Is it possible to allow re-entry when saving a flow by name?
      instructions:
      - text: Save flow {name} with steps {steps}.
        slots:
          name: path.name
          steps: requestBody.steps
      - text: Update flow {name} to allow re-entry {reentry_allowed} after {reentry_delay}.
        slots:
          name: path.name
          reentry_allowed: requestBody.reentry_allowed
          reentry_delay: requestBody.reentry_delay
      method: generated
      generated: '2026-10-02'
- target: $.paths['/flow/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a flow and all its versions
      effect: destructive
      questions:
      - How do I delete a flow entirely, every version included?
      - Does removing a flow by name wipe all of its versions?
      instructions:
      - text: Delete flow {name} and all of its versions.
        slots:
          name: path.name
      - text: Remove every version of flow {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-02'
- target: $.paths['/flow/{name}/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one version of a flow
      effect: read
      questions:
      - Can I look at an older version of a flow?
      - What did a specific numbered version of my flow contain?
      instructions:
      - text: Show version {version} of flow {name}.
        slots:
          version: path.version
          name: path.name
      - text: Fetch flow {name} at version {version}.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-02'
- target: $.paths['/flow/{name}/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single flow version
      effect: destructive
      questions:
      - Can I delete just one version of a flow and keep the others?
      - Is it possible to remove a bad flow version only?
      instructions:
      - text: Delete only version {version} of flow {name}.
        slots:
          version: path.version
          name: path.name
      - text: Remove flow {name} version {version}, keeping the rest.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-02'
- target: $.paths['/flow/{name}/{version}/{step}/work'].post
  update:
    x-apievangelist-phrasing:
      intent: Create the work for a flow step
      effect: write
      questions:
      - How do I create the job work behind one step of a flow version?
      - Can a single flow step be given its own work to run?
      instructions:
      - text: Create the work for step {step} of flow {name} version {version}.
        slots:
          step: path.step
          name: path.name
          version: path.version
      - text: Set up work for flow {name} v{version} step {step}.
        slots:
          name: path.name
          version: path.version
          step: path.step
      method: generated
      generated: '2026-10-02'