# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hightouch Decision Engine API
  version: 1.0.0
extends: openapi/hightouch-decision-engine-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: 7
- target: $.paths['/decision-engine/flow/{flowId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a decision engine flow
      effect: read
      questions:
      - How do I fetch the details of one decision engine flow by its ID?
      - What does a specific Hightouch decision flow look like?
      instructions:
      - text: Get decision engine flow {flowId}.
        slots:
          flowId: path.flowId
      - text: Show me the configuration of flow {flowId}.
        slots:
          flowId: path.flowId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/decision-engine/flows'].get
  update:
    x-apievangelist-phrasing:
      intent: List decision engine flows
      effect: read
      questions:
      - Which decision engine flows exist in my workspace?
      - Can I filter decision flows by name and page through them?
      instructions:
      - text: List all decision engine flows in my workspace.
      - text: Find decision flows named {name}.
        slots:
          name: query.name
      - text: List the next {limit} decision flows starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/decision-engine/flow/{flowId}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List the messages in a decision flow
      effect: read
      questions:
      - What messages are set up inside a given decision engine flow?
      - Can I page through all messages attached to one flow?
      instructions:
      - text: List the messages in flow {flowId}.
        slots:
          flowId: path.flowId
      - text: Show {limit} messages from flow {flowId} starting at {offset}.
        slots:
          limit: query.limit
          flowId: path.flowId
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/decision-engine/flow/{flowId}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a message to a decision flow
      effect: write
      questions:
      - How do I add a new message to a decision engine flow?
      - Can I set guardrails like max sends or eligibility dates when creating a flow message?
      instructions:
      - text: Create message {name} on channel {channelId} in flow {flowId} with config {config}.
        slots:
          name: requestBody.name
          channelId: requestBody.channelId
          flowId: path.flowId
          config: requestBody.config
      - text: Add message {name} to flow {flowId} on channel {channelId} using config {config} and guardrails {guardrails}.
        slots:
          name: requestBody.name
          flowId: path.flowId
          channelId: requestBody.channelId
          config: requestBody.config
          guardrails: requestBody.guardrails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/decision-engine/flow/{flowId}/messages/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one message in a decision flow
      effect: read
      questions:
      - How do I see the details of a single message in a decision flow?
      - What config and guardrails does a specific flow message have?
      instructions:
      - text: Get message {messageId} from flow {flowId}.
        slots:
          messageId: path.messageId
          flowId: path.flowId
      - text: Show the guardrails and variables of message {messageId} in flow {flowId}.
        slots:
          messageId: path.messageId
          flowId: path.flowId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/decision-engine/flow/{flowId}/messages/{messageId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing decision flow message
      effect: write
      questions:
      - Can I change the config or guardrails of a message already in a flow?
      - How do I rename a decision engine message?
      instructions:
      - text: Rename message {messageId} in flow {flowId} to {name}.
        slots:
          messageId: path.messageId
          flowId: path.flowId
          name: requestBody.name
      - text: Update the guardrails on message {messageId} in flow {flowId} to {guardrails}.
        slots:
          messageId: path.messageId
          flowId: path.flowId
          guardrails: requestBody.guardrails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/decision-engine/flow/{flowId}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a decision engine flow now
      effect: write
      questions:
      - How do I kick off a decision engine run on demand?
      - Can I trigger a decision flow manually instead of waiting for its schedule?
      instructions:
      - text: Trigger a run of decision flow {flowId}.
        slots:
          flowId: path.flowId
      - text: Start decision engine flow {flowId} now.
        slots:
          flowId: path.flowId
      method: generated
      generated: '2026-10-01'