# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Outbrain Amplify Segments API
  version: 1.0.0
extends: openapi/outbrain-segments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/segments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an audience segment
      effect: read
      questions:
      - What rules define membership in one of my audience segments?
      - How do I see the type and description of a single segment?
      instructions:
      - text: Show segment {id}.
        slots:
          id: path.id
      - text: Get the pixel rules and membership duration for segment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an audience segment
      effect: write
      questions:
      - How do I rename or disable an existing audience segment?
      - Can I change which campaigns' clickers feed a segment?
      instructions:
      - text: Disable segment {id}.
        slots:
          id: path.id
      - text: Update the pixel rules and description on segment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers/{marketerId}/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a marketer's audience segments
      effect: read
      questions:
      - Which audience segments does my marketer have?
      - Can I find a segment by exact name or include archived ones?
      instructions:
      - text: List all segments for marketer {marketerId}.
        slots:
          marketerId: path.marketerId
      - text: Find segments named {name} under marketer {marketerId}, including archived.
        slots:
          name: query.name
          marketerId: path.marketerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers/{marketerId}/segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new audience segment
      effect: write
      questions:
      - How do I build a retargeting segment from people who clicked my campaigns?
      - Can I create a pixel-based segment with a membership duration?
      instructions:
      - text: Create a clickers segment for marketer {marketerId} from my top two campaigns.
        slots:
          marketerId: path.marketerId
      - text: Create a pixel segment under marketer {marketerId} that keeps users for 30 days.
        slots:
          marketerId: path.marketerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audienceIntelSegments/all'].get
  update:
    x-apievangelist-phrasing:
      intent: List global audience intelligence segments
      effect: read
      questions:
      - What prebuilt global audience segments are available to target?
      - How are the audience intelligence segment groups organized?
      instructions:
      - text: List all global audience intel segments.
      - text: Show the global segment groups and their subgroups.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/segments/targetingCampaigns'].post
  update:
    x-apievangelist-phrasing:
      intent: Find campaigns targeting given segments
      effect: read
      questions:
      - Which campaigns are currently targeting a particular segment?
      - Can I check several segment IDs at once for the campaigns that use them?
      instructions:
      - text: Find every campaign that targets the segment IDs I give you.
      - text: List campaigns using these audience segments before I archive them.
      method: generated
      generated: '2026-09-26'