Taboola · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Taboola Backstage Audiences First Party Audiences API

4 actions 4 updates phrasing extends openapi/taboola-first-party-audiences-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Taboola's API. It is a proposal applied on top of the contract, not a document Taboola publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/{account_id}/audience_onboarding'].post
$.paths['/{account_id}/audience_onboarding/{audience_id}/users'].post
$.paths['/{account_id}/audience_onboarding/{audience_id}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Taboola Backstage Audiences First Party Audiences API
  version: 1.0.0
extends: openapi/taboola-first-party-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: 3
- target: $.paths['/{account_id}/audience_onboarding'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a first-party audience
      effect: write
      questions:
      - How do I create an audience from my own customer data?
      - Can I set how many days users stay in a first-party audience?
      instructions:
      - text: Create a first-party audience named {name} in account {account_id}.
        slots:
          name: requestBody.name
          account_id: path.account_id
      - text: Set up a first-party audience {name} for country {country} with a TTL of {ttl} days.
        slots:
          name: requestBody.name
          country: requestBody.country
          ttl: requestBody.ttl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/audience_onboarding/{audience_id}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or remove users in a first-party audience
      effect: write
      questions:
      - How do I upload hashed emails into one of my audiences?
      - Can I remove specific users from a first-party audience?
      instructions:
      - text: Add these hashed users to audience {audience_id} in account {account_id}.
        slots:
          audience_id: path.audience_id
          account_id: path.account_id
      - text: Run a {operation} of {users} on first-party audience {audience_id}.
        slots:
          operation: requestBody.operation
          users: requestBody.users
          audience_id: path.audience_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/audience_onboarding/{audience_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one first-party audience
      effect: read
      questions:
      - How do I check the details of a first-party audience I uploaded?
      - Can I fetch one of my onboarded audiences by its ID?
      instructions:
      - text: Get first-party audience {audience_id} in account {account_id}.
        slots:
          audience_id: path.audience_id
          account_id: path.account_id
      - text: Show the details of my onboarded audience {audience_id}.
        slots:
          audience_id: path.audience_id
      method: generated
      generated: '2026-09-26'