Lusha · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lusha API Documentation Search API

3 actions 3 updates phrasing extends openapi/lusha-search-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Lusha's API. It is a proposal applied on top of the contract, not a document Lusha publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v3/contacts/search'].post

$.paths['/v3/companies/search'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lusha API Documentation Search API
  version: 1.0.0
extends: openapi/lusha-search-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['/v3/contacts/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview contacts by identifier
      effect: read
      questions:
      - How do I check whether Lusha knows a person before spending credits?
      - Can I look up contacts by LinkedIn URL or email without revealing their phone?
      - How many contacts can I preview in one request?
      instructions:
      - text: 'Preview these contacts: {contacts}.'
        slots:
          contacts: requestBody.contacts
      - text: Look up contacts {contacts} and include {signals} signals.
        slots:
          contacts: requestBody.contacts
          signals: requestBody.signals
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview companies by identifier
      effect: read
      questions:
      - How do I check what data exists for a company before enriching it?
      - Can I look up companies by name or domain in bulk?
      instructions:
      - text: 'Preview these companies: {companies}.'
        slots:
          companies: requestBody.companies
      - text: Look up companies {companies} with {signals} signals.
        slots:
          companies: requestBody.companies
          signals: requestBody.signals
      method: generated
      generated: '2026-09-26'