BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Interactions API

2 actions 2 updates phrasing extends openapi/blueconic-interactions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/interactions'].get

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 BlueConic REST API v2 Interactions API
  version: 1.0.0
extends: openapi/blueconic-interactions-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: 1
- target: $.paths['/interactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the interactions to show a visitor
      effect: read
      questions:
      - Which dialogues or interactions should be shown to a visitor on a given page?
      - Can I get the interactions for a specific profile and channel?
      instructions:
      - text: Get the interactions for profile {profile} on page {url}.
        slots:
          profile: query.profile
          url: query.url
      - text: Fetch interactions for channel {channelId} at {url} with referrer {referer}.
        slots:
          channelId: query.channelId
          url: query.url
          referer: query.referer
      method: generated
      generated: '2026-10-01'