Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for cdp-api Tokens API

10 actions 10 updates phrasing extends openapi/treasure-data-tokens-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Treasure Data's API. It is a proposal applied on top of the contract, not a document Treasure Data publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info

$.paths['/audiences/{audienceId}/tokens'].get

$.paths['/audiences/{audienceId}/tokens'].post

$.paths['/audiences/{audienceId}/tokens/{tokenId}'].get

$.paths['/audiences/{audienceId}/tokens/{tokenId}'].put

$.paths['/audiences/{audienceId}/tokens/{tokenId}'].delete

$.paths['/entities/tokens'].post

$.paths['/entities/tokens/{id}'].get

$.paths['/entities/tokens/{id}'].delete

$.paths['/entities/tokens/{id}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for cdp-api Tokens API
  version: 1.0.0
extends: openapi/treasure-data-tokens-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: 9
- target: $.paths['/audiences/{audienceId}/tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List Profiles API tokens for a parent segment
      effect: read
      questions:
      - Which Profiles API tokens exist for a parent segment?
      - Can I see every profile lookup token tied to one audience?
      instructions:
      - text: List the Profiles API tokens for parent segment {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Show all profile lookup tokens on audience {audienceId}.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Profiles API token (legacy)
      effect: write
      questions:
      - How do I create a token for looking up customer profiles in legacy Audience Studio?
      - Which key column and attribute columns does a new Profiles API token need?
      instructions:
      - text: Create a Profiles API token on parent segment {audienceId} keyed by {keyColumn} returning {attributeColumns}.
        slots:
          audienceId: path.audienceId
          keyColumn: requestBody.keyColumn
          attributeColumns: requestBody.attributeColumns
      - text: Add a new legacy profile token to audience {audienceId} with key {keyColumn}, attributes {attributeColumns} and description {description}.
        slots:
          audienceId: path.audienceId
          keyColumn: requestBody.keyColumn
          attributeColumns: requestBody.attributeColumns
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/tokens/{tokenId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Profiles API token
      effect: read
      questions:
      - What columns and segments does a specific Profiles API token expose?
      - Can I look up one profile token by its ID?
      instructions:
      - text: Show Profiles API token {tokenId} on parent segment {audienceId}.
        slots:
          tokenId: path.tokenId
          audienceId: path.audienceId
      - text: Get the details of profile token {tokenId} for audience {audienceId}.
        slots:
          tokenId: path.tokenId
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/tokens/{tokenId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Profiles API token (legacy)
      effect: write
      questions:
      - Can I change which attribute columns an existing profile token returns?
      - Is it possible to edit a legacy Profiles API token's key column?
      instructions:
      - text: Update token {tokenId} on audience {audienceId} to key on {keyColumn} and return {attributeColumns}.
        slots:
          tokenId: path.tokenId
          audienceId: path.audienceId
          keyColumn: requestBody.keyColumn
          attributeColumns: requestBody.attributeColumns
      - text: Change the attribute columns of existing profile token {tokenId} in parent segment {audienceId} to {attributeColumns}, key {keyColumn}.
        slots:
          tokenId: path.tokenId
          audienceId: path.audienceId
          attributeColumns: requestBody.attributeColumns
          keyColumn: requestBody.keyColumn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audiences/{audienceId}/tokens/{tokenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Profiles API token (legacy)
      effect: destructive
      questions:
      - How do I revoke a profile lookup token so it stops working?
      - Can I delete a legacy Profiles API token from a parent segment?
      instructions:
      - text: Delete Profiles API token {tokenId} from parent segment {audienceId}.
        slots:
          tokenId: path.tokenId
          audienceId: path.audienceId
      - text: Revoke profile token {tokenId} on audience {audienceId}.
        slots:
          tokenId: path.tokenId
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/entities/tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Profiles API token via the entities API
      effect: write
      questions:
      - Can I create a Profiles API token in the current Audience Studio by entity?
      - What attributes does a new entities-API profile lookup token need?
      instructions:
      - text: Create entities-API Profiles token {id} of type {type} with attributes {attributes}.
        slots:
          id: requestBody.id
          type: requestBody.type
          attributes: requestBody.attributes
      - text: Create a Profiles API token entity {id} ({type}) with {attributes} linked to {relationships}.
        slots:
          id: requestBody.id
          type: requestBody.type
          attributes: requestBody.attributes
          relationships: requestBody.relationships
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/tokens/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Profiles API token by entity ID
      effect: read
      questions:
      - Can I look up a Profiles API token using only its entity ID?
      - What does the entities API return for a single profile token?
      instructions:
      - text: Get entities-API Profiles token {id}.
        slots:
          id: path.id
      - text: Fetch Profiles API token entity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/tokens/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Profiles API token via the entities API
      effect: destructive
      questions:
      - Can I revoke a Profiles API token by its entity ID?
      - What deletes a profile token in the current Audience Studio?
      instructions:
      - text: Delete entities-API Profiles token {id}.
        slots:
          id: path.id
      - text: Revoke Profiles API token entity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/tokens/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Profiles API token via the entities API
      effect: write
      questions:
      - Can I patch a Profiles API token's attributes by entity ID?
      - Which fields must I resend to update an entities-API profile token?
      instructions:
      - text: Patch entities-API Profiles token {id} with attributes {attributes}.
        slots:
          id: path.id
          attributes: requestBody.attributes
      - text: Update token entity {id} with body id {body_id}, type {type}, attributes {attributes}.
        slots:
          id: path.id
          body_id: requestBody.id
          type: requestBody.type
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'