Perigon · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Perigon AI & Advanced Search API

2 actions 2 updates phrasing extends openapi/perigon-ai-advanced-search-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/summarize'].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 Perigon AI & Advanced Search API
  version: 1.0.0
extends: openapi/perigon-ai-advanced-search-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['/v1/summarize'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize news coverage matching filters
      effect: read
      questions:
      - Can I get one AI-written summary of all recent news about a topic instead of reading every article?
      - How many articles can feed into a single news summary?
      - Is it possible to steer what a news summary focuses on with my own prompt?
      instructions:
      - text: Summarize the latest news coverage about {q}.
        slots:
          q: query.q
      - text: Write one summary of articles mentioning {companyName} published since {from}, focusing on {prompt}.
        slots:
          companyName: query.companyName
          from: query.from
          prompt: requestBody.prompt
      - text: Summarize the top {maxArticleCount} articles in {language} about {topic}.
        slots:
          maxArticleCount: requestBody.maxArticleCount
          language: query.language
          topic: query.topic
      method: generated
      generated: '2026-10-01'