# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Peopledatalabs Company API
  version: 1.0.0
extends: openapi/peopledatalabs-company-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: 5
- target: $.paths['/v5/company/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: Enrich a company by PDL ID, name or website (v5)
      effect: read
      questions:
      - Can I enrich a company when I already have its PDL ID?
      - Does the v5 company enrich endpoint accept a Crunchbase or Twitter profile?
      instructions:
      - text: Enrich the company with PDL ID {pdl_id} using v5.
        slots:
          pdl_id: query.pdl_id
      - text: Run v5 company enrichment for {name} with website {website}.
        slots:
          name: query.name
          website: query.website
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/company/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search companies with a v5 GET query
      effect: read
      questions:
      - How far can I paginate a v5 company search with an offset?
      - Can I get titlecased company names back from a v5 GET search?
      instructions:
      - text: Search companies with v5 GET using SQL {sql}, starting at offset {from}.
        slots:
          sql: query.sql
          from: query.from
      - text: Send a v5 GET company search for Elasticsearch query {query} with titlecased results.
        slots:
          query: query.query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/company/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search companies with a v5 POST query
      effect: read
      questions:
      - Can I send a company search as a POST request instead of GET?
      - What's the page size range when I POST a company search query?
      instructions:
      - text: POST the company search SQL {sql} and return {size} companies.
        slots:
          sql: query.sql
          size: query.size
      - text: Submit Elasticsearch query {query} to company search via POST, skipping the first {from}.
        slots:
          query: query.query
          from: query.from
      method: generated
      generated: '2026-10-01'
- target: $.paths['/company/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: Enrich one company's profile
      effect: read
      questions:
      - How do I get firmographic details for a company from its website domain?
      - Can I look up a company by its stock ticker?
      - What company profile comes back when I only know the name and location?
      instructions:
      - text: Enrich the company whose website is {website}.
        slots:
          website: query.website
      - text: Get the company profile for {name} located in {location}.
        slots:
          name: query.name
          location: query.location
      - text: Enrich the public company with ticker {ticker}.
        slots:
          ticker: query.ticker
      - text: Look up the company behind LinkedIn page {profile}.
        slots:
          profile: query.profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/company/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search companies with an SQL or Elasticsearch query
      effect: read
      questions:
      - Can I find all companies in a given industry and size range with one query?
      - Which query languages can I use to search the company dataset?
      - Is there a limit on how many companies a single search returns?
      instructions:
      - text: Search companies with the SQL query {sql}.
        slots:
          sql: query.sql
      - text: Run Elasticsearch query {query} over company profiles and return the top {size}.
        slots:
          query: query.query
          size: query.size
      method: generated
      generated: '2026-10-01'