API Evangelist conversational phrasing for api.peopledatalabs.com Company Endpoints API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for api.peopledatalabs.com Company Endpoints API
  version: 1.0.0
extends: openapi/peopledatalabs-company-endpoints-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['/v5/company/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: Enrich a company profile
      effect: read
      questions:
      - How do I get firmographics for a company from its website or ticker?
      - Can I require certain fields before a company enrichment counts as a match?
      - What minimum likelihood can I set so weak company matches are rejected?
      instructions:
      - text: Enrich the company with website {website}.
        slots:
          website: query.website
      - text: Enrich {name} headquartered in {locality}, {country}.
        slots:
          name: query.name
          locality: query.locality
          country: query.country
      - text: Enrich the public company with ticker {ticker}, only if likelihood is at least {min_likelihood}.
        slots:
          ticker: query.ticker
          min_likelihood: query.min_likelihood
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/company/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search companies with a GET query
      effect: read
      questions:
      - Can I find every company matching an industry and headcount filter with a GET search?
      - How many companies can one search page return?
      instructions:
      - text: Search companies with SQL {sql} as a GET request.
        slots:
          sql: query.sql
      - text: Get the next page of my GET company search using scroll token {scroll_token}.
        slots:
          scroll_token: query.scroll_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/company/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search companies with a POST body
      effect: read
      questions:
      - Can I send a long Elasticsearch company query in a JSON body?
      - Which search form lets me put the company query and scroll token in the request body?
      instructions:
      - text: POST the Elasticsearch company query {query} and return {size} companies.
        slots:
          query: requestBody.query
          size: requestBody.size
      - text: Continue my POST company search with scroll token {scroll_token}.
        slots:
          scroll_token: requestBody.scroll_token
      method: generated
      generated: '2026-10-01'