# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Segmentation Service Audiences API
  version: 1.0.0
extends: openapi/adobe-suite-audiences-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: 7
- target: $.paths['/audiences'].get
  update:
    x-apievangelist-phrasing:
      intent: List audiences
      effect: read
      questions:
      - Which audiences exist in my Experience Platform sandbox?
      - Can I filter audiences by name and page through the results?
      instructions:
      - text: List audiences in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Find audiences named {name}.
        slots:
          name: query.name
      - text: Show {limit} audiences sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an audience
      effect: write
      questions:
      - How do I create a new audience definition in Experience Platform?
      - Can I register an externally generated audience through the Segmentation API?
      instructions:
      - text: Create a new audience in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Add an audience for customers who bought in the last 30 days.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{AUDIENCE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audience's details
      effect: read
      questions:
      - What is the definition behind a specific audience?
      - Can I look up one audience by its ID?
      instructions:
      - text: Show audience {audience}.
        slots:
          audience: path.AUDIENCE_ID
      - text: Get the details of audience {audience}.
        slots:
          audience: path.AUDIENCE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{AUDIENCE_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an audience definition
      effect: write
      questions:
      - How do I overwrite an entire audience with a new definition?
      - Can I fully replace an audience rather than patching fields?
      instructions:
      - text: Replace audience {audience} with this new definition.
        slots:
          audience: path.AUDIENCE_ID
      - text: Overwrite the full definition of audience {audience}.
        slots:
          audience: path.AUDIENCE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{AUDIENCE_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an audience
      effect: destructive
      questions:
      - Can I permanently delete an audience I no longer need?
      - Is removing an audience reversible?
      instructions:
      - text: Delete audience {audience}.
        slots:
          audience: path.AUDIENCE_ID
      - text: Remove audience {audience} from the sandbox.
        slots:
          audience: path.AUDIENCE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{AUDIENCE_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change specific attributes of an audience
      effect: write
      questions:
      - Can I change just the name or description of an audience without resending it all?
      - What is the way to partially update an audience?
      instructions:
      - text: Patch the description of audience {audience}.
        slots:
          audience: path.AUDIENCE_ID
      - text: Rename audience {audience} with a partial update.
        slots:
          audience: path.AUDIENCE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/bulk-get'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several audiences by ID
      effect: read
      questions:
      - Can I retrieve many audiences in a single request?
      - What are the definitions of this list of audience IDs?
      instructions:
      - text: Get audiences {ids} in one request.
        slots:
          ids: requestBody.ids
      - text: 'Fetch these audiences together: {ids}.'
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'