AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Companies API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/companies/lookup'].get
$.paths['/companies/{id}'].get

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 Aiapplyd Companies API
  version: 1.0.0
extends: openapi/aiapplyd-companies-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['/companies/lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a company by name
      effect: read
      questions:
      - Can I look up a company just by typing its name?
      - Does company lookup tolerate small differences in how the name is written?
      instructions:
      - text: Look up the company named {name}.
        slots:
          name: query.name
      - text: Find the company profile matching {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company profile
      effect: read
      questions:
      - What information is on a company's profile?
      - Can I open a company profile by its ID?
      instructions:
      - text: Show company profile {id}.
        slots:
          id: path.id
      - text: Get the details of company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'