API Evangelist conversational phrasing for cdp-api Realtime Journeys API

# 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 Realtime Journeys API
  version: 1.0.0
extends: openapi/treasure-data-realtime-journeys-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: 32
- target: $.paths['/audiences/{audienceId}/realtime_setting'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audience's realtime setting
      effect: read
      questions:
      - Is realtime enabled for my audience, and how is it configured?
      - Which key columns and event tables does an audience's realtime setting use?
      instructions:
      - text: Show the realtime setting for audience {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Fetch the realtime key columns and event tables configured on audience {audienceId}.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_setting'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an audience's realtime setting
      effect: write
      questions:
      - How do I change which event tables feed realtime for an audience?
      - Can I set the external lookup key and batch attributes used in realtime?
      instructions:
      - text: 'Update audience {audienceId} realtime: keys {keyColumns}, events {eventTables}, batch attrs {batchAttributes}, lookup key {extLookupKey}.'
        slots:
          audienceId: path.audienceId
          keyColumns: requestBody.keyColumns
          eventTables: requestBody.eventTables
          batchAttributes: requestBody.batchAttributes
          extLookupKey: requestBody.extLookupKey
      - text: Point the realtime setting of audience {audienceId} at event tables {eventTables}.
        slots:
          audienceId: path.audienceId
          eventTables: requestBody.eventTables
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List an audience's realtime attributes
      effect: read
      questions:
      - What realtime attributes are defined on an audience?
      - Can I filter realtime attributes by name or type and page through them?
      instructions:
      - text: List the realtime attributes on audience {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Find realtime attributes in audience {audienceId} whose name includes {name_include}.
        slots:
          audienceId: path.audienceId
          name_include: query.name_include
      - text: List realtime attributes of type {types} for audience {audienceId}.
        slots:
          types: query.types
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a realtime attribute
      effect: write
      questions:
      - How do I add a new realtime attribute to an audience?
      - What name and identifier does a realtime attribute need?
      instructions:
      - text: Create a realtime attribute named {name} with identifier {identifier} on audience {audienceId}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          audienceId: path.audienceId
      - text: Add realtime attribute {name} to audience {audienceId} described as {description}.
        slots:
          name: requestBody.name
          audienceId: path.audienceId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a realtime attribute
      effect: read
      questions:
      - How is one specific realtime attribute defined?
      - Can I see the duration and aggregations of a single realtime attribute?
      instructions:
      - text: Show realtime attribute {realtimeAttributeId} on audience {audienceId}.
        slots:
          realtimeAttributeId: path.realtimeAttributeId
          audienceId: path.audienceId
      - text: Fetch the definition of realtime attribute {realtimeAttributeId} in audience {audienceId}.
        slots:
          realtimeAttributeId: path.realtimeAttributeId
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a realtime attribute
      effect: destructive
      questions:
      - How do I remove a realtime attribute from an audience?
      - Is deleting a realtime attribute permanent?
      instructions:
      - text: Delete realtime attribute {realtimeAttributeId} from audience {audienceId}.
        slots:
          realtimeAttributeId: path.realtimeAttributeId
          audienceId: path.audienceId
      - text: Remove the unused realtime attribute {realtimeAttributeId} in audience {audienceId}.
        slots:
          realtimeAttributeId: path.realtimeAttributeId
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_attributes/{realtimeAttributeId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a realtime attribute
      effect: write
      questions:
      - Can I change the time window or aggregations of a realtime attribute?
      - How many items a realtime attribute keeps - can I change that?
      instructions:
      - text: Set the duration of realtime attribute {realtimeAttributeId} in audience {audienceId} to {duration}.
        slots:
          realtimeAttributeId: path.realtimeAttributeId
          audienceId: path.audienceId
          duration: requestBody.duration
      - text: Change realtime attribute {realtimeAttributeId} in audience {audienceId} to keep at most {maxItems} items.
        slots:
          realtimeAttributeId: path.realtimeAttributeId
          audienceId: path.audienceId
          maxItems: requestBody.maxItems
      - text: Update the aggregations on realtime attribute {realtimeAttributeId} of audience {audienceId} to {aggregations}.
        slots:
          realtimeAttributeId: path.realtimeAttributeId
          audienceId: path.audienceId
          aggregations: requestBody.aggregations
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_imported_attributes/bulk_update'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk update imported realtime attributes
      effect: write
      questions:
      - Can I update many imported attributes for realtime in one call?
      - How do I change which batch columns are imported into realtime at once?
      instructions:
      - text: Bulk update the imported attributes of audience {audienceId} with columns {columns}.
        slots:
          audienceId: path.audienceId
          columns: requestBody.columns
      - text: Replace the imported realtime columns for audience {audienceId} in one bulk update.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_key_events'].get
  update:
    x-apievangelist-phrasing:
      intent: List an audience's realtime key events
      effect: read
      questions:
      - Which realtime key events are defined for an audience?
      - Can I filter key events by name and page through the results?
      instructions:
      - text: List the realtime key events for audience {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Find key events in audience {audienceId} whose name includes {name_include}.
        slots:
          audienceId: path.audienceId
          name_include: query.name_include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_key_events'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a realtime key event
      effect: write
      questions:
      - How do I define a key event that triggers realtime processing?
      - What table and filter rule does a new key event need?
      instructions:
      - text: Create key event {name} on audience {audienceId} from {databaseName}.{tableName} filtered by {filterRule}.
        slots:
          name: requestBody.name
          audienceId: path.audienceId
          databaseName: requestBody.databaseName
          tableName: requestBody.tableName
          filterRule: requestBody.filterRule
      - text: Add a new realtime key event {name} for audience {audienceId} watching table {tableName} in database {databaseName} with rule {filterRule}.
        slots:
          name: requestBody.name
          audienceId: path.audienceId
          tableName: requestBody.tableName
          databaseName: requestBody.databaseName
          filterRule: requestBody.filterRule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a realtime key event
      effect: read
      questions:
      - How is one specific key event defined?
      - Can I see the filter rule of a single realtime key event?
      instructions:
      - text: Show key event {realtimeKeyEventId} in audience {audienceId}.
        slots:
          realtimeKeyEventId: path.realtimeKeyEventId
          audienceId: path.audienceId
      - text: Fetch the definition of realtime key event {realtimeKeyEventId} for audience {audienceId}.
        slots:
          realtimeKeyEventId: path.realtimeKeyEventId
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a realtime key event
      effect: destructive
      questions:
      - How do I remove a key event from an audience?
      - Is deleting a realtime key event permanent?
      instructions:
      - text: Delete key event {realtimeKeyEventId} from audience {audienceId}.
        slots:
          realtimeKeyEventId: path.realtimeKeyEventId
          audienceId: path.audienceId
      - text: Remove the obsolete realtime key event {realtimeKeyEventId} in audience {audienceId}.
        slots:
          realtimeKeyEventId: path.realtimeKeyEventId
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a realtime key event
      effect: write
      questions:
      - Can I change the source table or filter rule of an existing key event?
      - What must I resend when editing a realtime key event?
      instructions:
      - text: 'Edit key event {realtimeKeyEventId} in audience {audienceId}: name {name}, source {databaseName}.{tableName}, rule {filterRule}.'
        slots:
          realtimeKeyEventId: path.realtimeKeyEventId
          audienceId: path.audienceId
          name: requestBody.name
          databaseName: requestBody.databaseName
          tableName: requestBody.tableName
          filterRule: requestBody.filterRule
      - text: Change the filter rule of existing key event {realtimeKeyEventId} in audience {audienceId} to {filterRule}.
        slots:
          realtimeKeyEventId: path.realtimeKeyEventId
          audienceId: path.audienceId
          filterRule: requestBody.filterRule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_key_events/{realtimeKeyEventId}/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List columns of a realtime key event
      effect: read
      questions:
      - Which columns are available on a particular key event?
      - What fields can I use from a realtime key event's table?
      instructions:
      - text: List the columns of key event {realtimeKeyEventId} in audience {audienceId}.
        slots:
          realtimeKeyEventId: path.realtimeKeyEventId
          audienceId: path.audienceId
      - text: Show which fields key event {realtimeKeyEventId} exposes for audience {audienceId}.
        slots:
          realtimeKeyEventId: path.realtimeKeyEventId
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_event_tables/{database}/{table}/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List columns of a realtime event table
      effect: read
      questions:
      - What columns does an event table in my realtime setting have?
      - Can I inspect the schema of a realtime event table by database and table name?
      instructions:
      - text: List the columns of event table {database}.{table} for audience {audienceId}.
        slots:
          database: path.database
          table: path.table
          audienceId: path.audienceId
      - text: Show the schema of realtime event table {table} in database {database}, audience {audienceId}.
        slots:
          table: path.table
          database: path.database
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audiences/{audienceId}/realtime_configuration_versions/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current realtime configuration version
      effect: read
      questions:
      - Which realtime configuration version is live for an audience right now?
      - Can I check the current version of an audience's realtime config?
      instructions:
      - text: Show the current realtime configuration version for audience {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Tell me which realtime config version audience {audienceId} is running.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/parent_segments/{parentSegmentId}/realtime_attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List realtime attributes available to journeys
      effect: read
      questions:
      - Which realtime attributes can I use when building a journey in a parent segment?
      - Can I search the available realtime attributes with a keyword?
      instructions:
      - text: List the realtime attributes available to journeys in parent segment {parentSegmentId}.
        slots:
          parentSegmentId: path.parentSegmentId
      - text: Search available realtime attributes in parent segment {parentSegmentId} for {q}.
        slots:
          parentSegmentId: path.parentSegmentId
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a realtime journey
      effect: write
      questions:
      - How do I build a new realtime customer journey?
      - What attributes does a new realtime journey require?
      instructions:
      - text: Create a realtime journey with attributes {attributes}.
        slots:
          attributes: requestBody.attributes
      - text: Build a new realtime journey from scratch using {attributes}.
        slots:
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a realtime journey summary
      effect: read
      questions:
      - What does a particular realtime journey look like?
      - Can I get the summary of one realtime journey by ID?
      instructions:
      - text: Show the summary of realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      - text: Fetch realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a realtime journey
      effect: destructive
      questions:
      - How do I delete a realtime journey entirely?
      - Is deleting a realtime journey permanent?
      instructions:
      - text: Delete realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      - text: Remove the retired realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a realtime journey
      effect: write
      questions:
      - Can I edit an existing realtime journey after creating it?
      - What happens when I save changes to a realtime journey entity?
      instructions:
      - text: Update realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      - text: Save my edits to the existing realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}/detail'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a realtime journey's fields
      effect: read
      questions:
      - Can I check a realtime journey's fields for errors before saving?
      - How do I validate the configuration of a realtime journey?
      instructions:
      - text: Validate the fields of realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      - text: Check whether attributes {attributes} are valid for realtime journey {realtimeJourneyId}.
        slots:
          attributes: requestBody.attributes
          realtimeJourneyId: path.realtimeJourneyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/parent_segments/{parentSegmentId}/realtime_journeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List realtime journeys in a parent segment
      effect: read
      questions:
      - Which realtime journeys exist under a parent segment?
      - Can I list only the realtime journeys I am allowed to edit?
      instructions:
      - text: List realtime journeys under parent segment {parentSegmentId}.
        slots:
          parentSegmentId: path.parentSegmentId
      - text: List realtime journeys in parent segment {parentSegmentId} where I have {permissions} permission.
        slots:
          parentSegmentId: path.parentSegmentId
          permissions: query.permissions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/parent_segments/{parentSegmentId}/realtime_activations'].get
  update:
    x-apievangelist-phrasing:
      intent: List realtime activations in a parent segment
      effect: read
      questions:
      - What realtime activations are running across a whole parent segment?
      - Can I page through every realtime activation in a parent segment?
      instructions:
      - text: List all realtime activations under parent segment {parentSegmentId}.
        slots:
          parentSegmentId: path.parentSegmentId
      - text: Show the first {size} realtime activations in parent segment {parentSegmentId}.
        slots:
          size: query.page[size]
          parentSegmentId: path.parentSegmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}/activations'].get
  update:
    x-apievangelist-phrasing:
      intent: List activations of a realtime journey
      effect: read
      questions:
      - Which activation steps belong to one realtime journey?
      - Can I page through the activations of a single journey?
      instructions:
      - text: List the activations in realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      - text: Show the first {size} activation steps of journey {realtimeJourneyId}.
        slots:
          size: query.page[size]
          realtimeJourneyId: path.realtimeJourneyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}/activations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an activation to a realtime journey
      effect: write
      questions:
      - How do I add an activation step to a realtime journey?
      - What attributes does a new journey activation need?
      instructions:
      - text: Add an activation to realtime journey {realtimeJourneyId} with attributes {attributes}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
          attributes: requestBody.attributes
      - text: Create a new activation step in journey {realtimeJourneyId} using {attributes}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}/activations/{realtimeJourneyActivationStepId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an activation node in a realtime journey
      effect: read
      questions:
      - What is configured on one activation node of a journey?
      - Can I get the summary of a single activation step by its ID?
      instructions:
      - text: Show activation step {realtimeJourneyActivationStepId} in realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyActivationStepId: path.realtimeJourneyActivationStepId
          realtimeJourneyId: path.realtimeJourneyId
      - text: Fetch the summary of activation node {realtimeJourneyActivationStepId} of journey {realtimeJourneyId}.
        slots:
          realtimeJourneyActivationStepId: path.realtimeJourneyActivationStepId
          realtimeJourneyId: path.realtimeJourneyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}/activations/{realtimeJourneyActivationStepId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an activation node in a realtime journey
      effect: write
      questions:
      - Can I change the settings of an existing activation step in a journey?
      - What do I send to edit a journey's activation node?
      instructions:
      - text: Update activation step {realtimeJourneyActivationStepId} in journey {realtimeJourneyId} with {attributes}.
        slots:
          realtimeJourneyActivationStepId: path.realtimeJourneyActivationStepId
          realtimeJourneyId: path.realtimeJourneyId
          attributes: requestBody.attributes
      - text: Change the existing activation node {realtimeJourneyActivationStepId} of journey {realtimeJourneyId} to use {attributes}.
        slots:
          realtimeJourneyActivationStepId: path.realtimeJourneyActivationStepId
          realtimeJourneyId: path.realtimeJourneyId
          attributes: requestBody.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}/pause'].patch
  update:
    x-apievangelist-phrasing:
      intent: Pause a realtime journey's activations
      effect: write
      questions:
      - How do I temporarily stop a realtime journey from sending activations?
      - Can I pause a journey without deleting it?
      instructions:
      - text: Pause activations in realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      - text: Put journey {realtimeJourneyId} on hold so it stops activating.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/{realtimeJourneyId}/resume'].patch
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused realtime journey
      effect: write
      questions:
      - How do I restart activations on a journey I paused?
      - Can a paused realtime journey pick up again?
      instructions:
      - text: Resume activations in paused realtime journey {realtimeJourneyId}.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      - text: Turn journey {realtimeJourneyId} back on after the pause.
        slots:
          realtimeJourneyId: path.realtimeJourneyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/duplicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a realtime journey
      effect: write
      questions:
      - Can I copy an existing realtime journey as a starting point?
      - What do I need to duplicate a realtime journey?
      instructions:
      - text: Duplicate realtime journey {id} as type {type} with attributes {attributes} and relationships {relationships}.
        slots:
          id: requestBody.id
          type: requestBody.type
          attributes: requestBody.attributes
          relationships: requestBody.relationships
      - text: Make a copy of journey {id} using {attributes}, {relationships} and type {type}.
        slots:
          id: requestBody.id
          attributes: requestBody.attributes
          relationships: requestBody.relationships
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/realtime_journeys/abtest_variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List A/B test variants in an audience
      effect: read
      questions:
      - Which A/B test variants are available for realtime journeys in an audience?
      - Can I see the journey variants I could A/B test against each other?
      instructions:
      - text: List the A/B test variants available in audience {audience_id}.
        slots:
          audience_id: query.audience_id
      - text: Show the viewable realtime journey A/B variants for audience {audience_id}.
        slots:
          audience_id: query.audience_id
      method: generated
      generated: '2026-10-01'