Outbrain · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Outbrain Engage Recommendations API

2 actions 2 updates phrasing extends openapi/outbrain-recommendations-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/utils/get'].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 Outbrain Engage Recommendations API
  version: 1.0.0
extends: openapi/outbrain-recommendations-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: 1
- target: $.paths['/utils/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch recommendations for a publisher widget
      effect: read
      questions:
      - How do I get the recommended articles and sponsored links for a widget on my page?
      - Can I request a second page of recommendations for the same widget?
      - Do widget recommendations include both organic and paid content?
      instructions:
      - text: Get recommendations for widget {widget} on page {permalink} with publisher key {publisherKey}.
        slots:
          widget: query.widgetJSId
          permalink: query.permalink
          publisherKey: query.publisherKey
      - text: Fetch page {pageNum} of recommendations for widget {widget} on {permalink} using key {publisherKey}.
        slots:
          pageNum: query.pageNum
          widget: query.widgetJSId
          permalink: query.permalink
          publisherKey: query.publisherKey
      method: generated
      generated: '2026-09-26'