Lusha · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lusha API Documentation Enrichment API

5 actions 5 updates phrasing extends openapi/lusha-enrichment-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 5

$.info
$.paths['/v2/person'].get
$.paths['/v2/person'].post
$.paths['/v2/company'].get
$.paths['/v2/company'].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 Lusha API Documentation Enrichment API
  version: 1.0.0
extends: openapi/lusha-enrichment-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: 4
- target: $.paths['/v2/person'].get
  update:
    x-apievangelist-phrasing:
      intent: Find and enrich one person
      effect: read
      questions:
      - How do I get the email and phone for one person from their LinkedIn URL?
      - Can I look up a single contact by name and company domain?
      - Can I ask for only emails and not phone numbers for one person?
      instructions:
      - text: Find the contact with LinkedIn profile {linkedinUrl}.
        slots:
          linkedinUrl: query.linkedinUrl
      - text: Look up {firstName} {lastName} at {companyDomain}.
        slots:
          firstName: query.firstName
          lastName: query.lastName
          companyDomain: query.companyDomain
      - text: Enrich the person with email {email} and include their signals since {signalsStartDate}.
        slots:
          email: query.email
          signalsStartDate: query.signalsStartDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/person'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich a batch of people at once
      effect: read
      questions:
      - How do I enrich a whole list of contacts in one request?
      - Does bulk person enrichment include company information for each contact?
      instructions:
      - text: 'Enrich these contacts in bulk: {contacts}.'
        slots:
          contacts: requestBody.contacts
      - text: Run a bulk person lookup for {contacts} with metadata {metadata}.
        slots:
          contacts: requestBody.contacts
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/company'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one company
      effect: read
      questions:
      - How do I get company details from a website domain?
      - Can I look up a single company by its name?
      - Can I include recent signals such as news when I look up one company?
      instructions:
      - text: Look up the company at domain {domain}.
        slots:
          domain: query.domain
      - text: Get details for the company named {company}.
        slots:
          company: query.company
      - text: Show company {companyId} with its signals since {signalsStartDate}.
        slots:
          companyId: query.companyId
          signalsStartDate: query.signalsStartDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/company'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up a batch of companies at once
      effect: read
      questions:
      - How do I enrich a list of company domains in one call?
      - Can a bulk company lookup also return signals from a start date?
      instructions:
      - text: 'Enrich these companies in bulk: {companies}.'
        slots:
          companies: requestBody.companies
      - text: Bulk look up {companies} with {signals} signals since {signalsStartDate}.
        slots:
          companies: requestBody.companies
          signals: requestBody.signals
          signalsStartDate: requestBody.signalsStartDate
      method: generated
      generated: '2026-09-26'