Surfe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Surfe Recommendations API

3 actions 3 updates phrasing extends openapi/surfe-recommendations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Surfe's API. It is a proposal applied on top of the contract, not a document Surfe publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/recommendations/icp'].post
$.paths['/recommendations/fetch'].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 Surfe Recommendations API
  version: 1.0.0
extends: openapi/surfe-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: 2
- target: $.paths['/recommendations/icp'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update the ideal customer profile
      effect: write
      questions:
      - How do I define my ideal customer profile for lookalike recommendations?
      - Can I change the company filters on my saved ICP?
      instructions:
      - text: Save my ideal customer profile as {name} with filters {filters}.
        slots:
          name: requestBody.name
          filters: requestBody.filters
      - text: Update my ICP company filters to {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/recommendations/fetch'].post
  update:
    x-apievangelist-phrasing:
      intent: Get lookalike account recommendations
      effect: read
      questions:
      - Which new accounts look like my best-fit customers?
      - Can Surfe suggest lookalike companies based on my ICP?
      - Is there a limit on how many lookalike recommendations I get back at once?
      instructions:
      - text: Fetch {limit} lookalike account recommendations for my ICP.
        slots:
          limit: requestBody.limit
      - text: Show the next page of lookalike accounts using token {pageToken}.
        slots:
          pageToken: requestBody.pageToken
      method: generated
      generated: '2026-09-26'