BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Recommendations API

2 actions 2 updates phrasing extends openapi/blueconic-recommendations-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['/recommendations'].post

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 Recommendations API
  version: 1.0.0
extends: openapi/blueconic-recommendations-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['/recommendations'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate content recommendations for a visitor
      effect: read
      questions:
      - How do I get personalized product or article recommendations for a visitor?
      - Can I cap how often the same item gets recommended?
      - Can I get recommendations related to a specific item?
      instructions:
      - text: Recommend items from store {storeId} for profile {profileId}.
        slots:
          storeId: query.storeId
          profileId: query.profileId
      - text: Get recommendations from store {storeId} similar to item {itemId}.
        slots:
          storeId: query.storeId
          itemId: query.itemId
      - text: Recommend from store {storeId} with frequency cap {frequencyCap}.
        slots:
          storeId: query.storeId
          frequencyCap: query.frequencyCap
      method: generated
      generated: '2026-10-01'