Profound · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for External Content API

3 actions 3 updates phrasing extends openapi/profound-content-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/content/{asset_id}/optimization'].get

$.paths['/v1/content/{asset_id}/optimization/{content_id}'].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 External Content API
  version: 1.0.0
extends: openapi/profound-content-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: 2
- target: $.paths['/v1/content/{asset_id}/optimization'].get
  update:
    x-apievangelist-phrasing:
      intent: List content optimizations for an asset
      effect: read
      questions:
      - Which content optimization analyses exist for my brand asset?
      - Can I page through an asset's optimization results with limit and offset?
      instructions:
      - text: List the content optimizations for asset {asset_id}.
        slots:
          asset_id: path.asset_id
      - text: Show {limit} optimization entries for asset {asset_id} starting at offset {offset}.
        slots:
          asset_id: path.asset_id
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/content/{asset_id}/optimization/{content_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one content optimization analysis
      effect: read
      questions:
      - What does the optimization analysis say about a specific piece of content?
      - Can I open the detailed analysis for one content item under my asset?
      instructions:
      - text: Get the optimization analysis for content {content_id} under asset {asset_id}.
        slots:
          asset_id: path.asset_id
          content_id: path.content_id
      - text: Open analysis {content_id} for asset {asset_id}.
        slots:
          asset_id: path.asset_id
          content_id: path.content_id
      method: generated
      generated: '2026-10-01'