lemlist · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for lemlist Signal Agents API

11 actions 11 updates phrasing extends openapi/lemlist-signal-agents-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for lemlist's API. It is a proposal applied on top of the contract, not a document lemlist publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/watchlist/signals'].get
$.paths['/watchlist/{watchListId}/external-signals'].post
$.paths['/watchlist'].get
$.paths['/watchlist'].post
$.paths['/watchlist'].delete
$.paths['/watchlist'].patch
$.paths['/watchlist/history'].get
$.paths['/watchlist/library'].get
$.paths['/watchlist/filters'].get
$.paths['/watchlist/filter-values'].get

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 lemlist Signal Agents API
  version: 1.0.0
extends: openapi/lemlist-signal-agents-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: 10
- target: $.paths['/watchlist/signals'].get
  update:
    x-apievangelist-phrasing:
      intent: Get signals detected by my Signal Agents
      effect: read
      questions:
      - What buying signals have my Signal Agents picked up this week?
      - Can I filter detected signals by type, status or date received?
      instructions:
      - text: Show the signals from Signal Agent {watchListId}.
        slots:
          watchListId: query.watchListId
      - text: List {type} signals received between {receivedAtFrom} and {receivedAtTo}.
        slots:
          type: query.type
          receivedAtFrom: query.receivedAtFrom
          receivedAtTo: query.receivedAtTo
      - text: Get page {page} of signals with status {status}.
        slots:
          page: query.page
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/watchlist/{watchListId}/external-signals'].post
  update:
    x-apievangelist-phrasing:
      intent: Push an external signal into a Signal Agent
      effect: write
      questions:
      - How do I feed signals from my own tools into a lemlist Signal Agent?
      - Can I attach custom metadata to a signal I push in?
      instructions:
      - text: Push a signal about contact {contact} to external agent {watchListId}.
        slots:
          contact: requestBody.contact
          watchListId: path.watchListId
      - text: Send an external company signal for {company} to agent {watchListId} with metadata {customFields}.
        slots:
          company: requestBody.company
          watchListId: path.watchListId
          customFields: requestBody.customFields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/watchlist'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Signal Agents
      effect: read
      questions:
      - Which Signal Agents has my team set up?
      - Can I see deleted Signal Agents as well as active ones?
      instructions:
      - text: List all my Signal Agents.
      - text: Show Signal Agents of type {type} in status {status}.
        slots:
          type: query.type
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/watchlist'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Signal Agent
      effect: write
      questions:
      - How do I set up an agent that watches for a particular buying signal?
      - Can I fully activate a new Signal Agent in the same call that creates it?
      instructions:
      - text: Create a Signal Agent named {name} monitoring {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Create and activate agent {name} for {type} with filters {filters}, processing {signalProcessingType}, activate {activate}.
        slots:
          name: requestBody.name
          type: requestBody.type
          filters: requestBody.filters
          signalProcessingType: requestBody.signalProcessingType
          activate: requestBody.activate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/watchlist'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Signal Agent
      effect: destructive
      questions:
      - How do I delete a Signal Agent I don't need anymore?
      - Can I stop and remove an agent that watches for signals?
      instructions:
      - text: Delete Signal Agent {watchListId}.
        slots:
          watchListId: query.watchListId
      - text: Remove the signal watcher {watchListId}.
        slots:
          watchListId: query.watchListId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/watchlist'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Signal Agent
      effect: write
      questions:
      - Can I rename a Signal Agent or change its emoji?
      - How do I swap the filters on an existing Signal Agent?
      instructions:
      - text: Rename Signal Agent {watchListId} to {name}.
        slots:
          watchListId: requestBody.watchListId
          name: requestBody.name
      - text: Replace the filters of agent {watchListId} with {filters}.
        slots:
          watchListId: requestBody.watchListId
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/watchlist/history'].get
  update:
    x-apievangelist-phrasing:
      intent: See a Signal Agent's configuration history
      effect: read
      questions:
      - Who changed my Signal Agent's settings, and when?
      - Can I audit past configuration versions of an agent?
      instructions:
      - text: Show the configuration history of Signal Agent {watchListId}.
        slots:
          watchListId: query.watchListId
      - text: Get page {page} of change history for agent {watchListId}.
        slots:
          page: query.page
          watchListId: query.watchListId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/watchlist/library'].get
  update:
    x-apievangelist-phrasing:
      intent: List the signal types I can monitor
      effect: read
      questions:
      - What kinds of signals can a lemlist Signal Agent watch for?
      - Which signal types are available in the library?
      instructions:
      - text: List every available signal type.
      - text: Show the signal library.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/watchlist/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List allowed filters per signal type
      effect: read
      questions:
      - Which filters can I apply to a given signal type?
      - What filter options exist when configuring a Signal Agent?
      instructions:
      - text: Show the allowed filters for signal type {type}.
        slots:
          type: query.type
      - text: List filters for every signal type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/watchlist/filter-values'].get
  update:
    x-apievangelist-phrasing:
      intent: Autocomplete values for a Signal Agent filter
      effect: read
      questions:
      - How do I find valid values to put in a Signal Agent filter?
      - Can I search the options for a filter by typing part of a name?
      instructions:
      - text: Suggest values for filter {filterId} matching {query}.
        slots:
          filterId: query.filterId
          query: query.query
      - text: List the possible values of filter {filterId}.
        slots:
          filterId: query.filterId
      method: generated
      generated: '2026-10-01'