# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lusha Signals API
  version: 1.0.0
extends: openapi/lusha-signals-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: 13
- target: $.paths['/v3/contacts/signals'].post
  update:
    x-apievangelist-phrasing:
      intent: Get job changes and promotions for contacts
      effect: read
      questions:
      - Which of my contacts recently got promoted or changed companies?
      - Can I limit contact signal results to events after a date?
      - How many contacts can I pull signals for at once?
      instructions:
      - text: Get {signalTypes} signals for contacts {ids}.
        slots:
          signalTypes: requestBody.signalTypes
          ids: requestBody.ids
      - text: Show {signalTypes} events for contacts {ids} since {startDate}.
        slots:
          signalTypes: requestBody.signalTypes
          ids: requestBody.ids
          startDate: requestBody.startDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/signals'].post
  update:
    x-apievangelist-phrasing:
      intent: Get hiring, news and growth signals for companies
      effect: read
      questions:
      - Which of my target accounts are hiring or in the news?
      - Can I see headcount changes and IT spend signals for a list of companies?
      - How many results per signal type can I get for each company?
      instructions:
      - text: Get {signalTypes} signals for companies {ids}.
        slots:
          signalTypes: requestBody.signalTypes
          ids: requestBody.ids
      - text: Show {signalTypes} for companies {ids} since {startDate}, at most {maxResultsPerSignal} per signal.
        slots:
          signalTypes: requestBody.signalTypes
          ids: requestBody.ids
          startDate: requestBody.startDate
          maxResultsPerSignal: requestBody.maxResultsPerSignal
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/signals/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact signal types
      effect: read
      questions:
      - What kinds of signals does Lusha track for people?
      - Which contact signal type names can I request?
      instructions:
      - text: List the supported contact signal types.
      - text: Show every signal type available for contacts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/signals/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List company signal types
      effect: read
      questions:
      - What kinds of signals are tracked for companies?
      - Which company signal type names can I request?
      instructions:
      - text: List the supported company signal types.
      - text: Show every signal type available for companies.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/signals/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List company signal filter types
      effect: read
      questions:
      - What filters can I apply to company signals, like news event type?
      - Which company signal filters need a search query?
      instructions:
      - text: List the filter types for company signals.
      - text: Show which company signal filters require a query.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/signals/filters/{filterType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get values for one company signal filter
      effect: read
      questions:
      - What news event types can I filter company signals by?
      - How do I find hiring location values for a company signal filter?
      instructions:
      - text: Show the valid values for company signal filter {filterType}.
        slots:
          filterType: path.filterType
      - text: Search company signal filter {filterType} for {query}.
        slots:
          filterType: path.filterType
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/signal-score'].post
  update:
    x-apievangelist-phrasing:
      intent: Score companies by buying signal activity
      effect: read
      questions:
      - Which of my accounts show the most active buying signals?
      - What does a company signal score between 0 and 1 mean?
      - Can I score companies by domain instead of Lusha ID?
      instructions:
      - text: 'Score these companies by signal activity: {companies}.'
        slots:
          companies: requestBody.companies
      - text: Rank accounts {companies} by their buying signal score.
        slots:
          companies: requestBody.companies
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/contacts/signal-score'].post
  update:
    x-apievangelist-phrasing:
      intent: Score contacts by buying signal activity
      effect: read
      questions:
      - Which of my contacts have the strongest buying signals right now?
      - Can I get a signal score for up to 100 people at once?
      instructions:
      - text: 'Score these contacts by signal activity: {contacts}.'
        slots:
          contacts: requestBody.contacts
      - text: Rank people {contacts} by their buying signal score.
        slots:
          contacts: requestBody.contacts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/signals/filters/{objectType}'].get
  update:
    x-apievangelist-phrasing:
      intent: List signal options for contacts or companies (legacy)
      effect: read
      questions:
      - Which signal options can I use when enriching with the older signals endpoints?
      - What legacy signal filters exist for contact versus company objects?
      instructions:
      - text: List the legacy signal options for {objectType}.
        slots:
          objectType: path.objectType
      - text: Show which signals I can filter {objectType} enrichment by.
        slots:
          objectType: path.objectType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/signals/contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Get signals for contact IDs (legacy)
      effect: read
      questions:
      - How do I pull signals for contact IDs with the older signals API?
      - Does the legacy contact signals call have a default lookback period?
      instructions:
      - text: Using the legacy endpoint, get {signals} signals for contact IDs {contactIds}.
        slots:
          signals: requestBody.signals
          contactIds: requestBody.contactIds
      - text: Fetch legacy {signals} signals for contact IDs {contactIds} since {startDate}.
        slots:
          signals: requestBody.signals
          contactIds: requestBody.contactIds
          startDate: requestBody.startDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/signals/contacts/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up people and their signals together
      effect: read
      questions:
      - Can I get signals for a person using just their LinkedIn URL or email?
      - How do I find a contact by name and company and see their job changes?
      instructions:
      - text: Find contacts {contacts} and return their {signals} signals.
        slots:
          contacts: requestBody.contacts
          signals: requestBody.signals
      - text: Search signals for people {contacts} with {signals} since {startDate}.
        slots:
          contacts: requestBody.contacts
          signals: requestBody.signals
          startDate: requestBody.startDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/signals/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Get signals for company IDs (legacy)
      effect: read
      questions:
      - How do I pull signals for company IDs with the older signals API?
      - Can I filter legacy company signals by department or location?
      instructions:
      - text: Using the legacy endpoint, get {signals} signals for company IDs {companyIds}.
        slots:
          signals: requestBody.signals
          companyIds: requestBody.companyIds
      - text: Fetch legacy {signals} signals for company IDs {companyIds} with filters {filters}.
        slots:
          signals: requestBody.signals
          companyIds: requestBody.companyIds
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/signals/companies/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up companies and their signals together
      effect: read
      questions:
      - Can I get signals for a company using only its domain or name?
      - How do I look up an account and see its latest news in one call?
      instructions:
      - text: Find companies {companies} and return their {signals} signals.
        slots:
          companies: requestBody.companies
          signals: requestBody.signals
      - text: Search signals for accounts {companies} with {signals} since {startDate}.
        slots:
          companies: requestBody.companies
          signals: requestBody.signals
          startDate: requestBody.startDate
      method: generated
      generated: '2026-09-26'