Profound · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for External Prompts API

4 actions 4 updates phrasing extends openapi/profound-prompts-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 4

$.info
$.paths['/v1/prompts/answers'].post
$.paths['/v2/prompts/answers'].post
$.paths['/v2/prompts/answers/stream'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for External Prompts API
  version: 1.0.0
extends: openapi/profound-prompts-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: 3
- target: $.paths['/v1/prompts/answers'].post
  update:
    x-apievangelist-phrasing:
      intent: Get AI answers to tracked prompts
      effect: read
      questions:
      - What did AI assistants actually answer to the prompts we track?
      - Can I pull the raw answers for a category over a date range with filters?
      instructions:
      - text: Get the AI answers for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Fetch answers in category {category_id} between {start_date} and {end_date} filtered by {filters} using the original v1 endpoint.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/prompts/answers'].post
  update:
    x-apievangelist-phrasing:
      intent: Query prompt answers with cursor paging
      effect: read
      questions:
      - Is there a newer answers query that pages with a cursor?
      - Can I cap how many prompt answers come back in total?
      instructions:
      - text: Query v2 answers for category {category_id} from {start_date} to {end_date}, {limit} per page.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          limit: requestBody.limit
      - text: Continue the v2 answer query for category {category_id}, {start_date}–{end_date}, from cursor {cursor}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          cursor: requestBody.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/prompts/answers/stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream prompt answers
      effect: read
      questions:
      - Can I stream a large set of AI answers instead of paging?
      - What's the way to export every answer in a long date range as a stream?
      instructions:
      - text: Stream all answers for category {category_id} from {start_date} through {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Open a streaming export of answers in category {category_id} ({start_date} to {end_date}) up to {max_results} rows.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          max_results: requestBody.max_results
      method: generated
      generated: '2026-10-01'