# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lemlist People database API
  version: 1.0.0
extends: openapi/lemlist-people-database-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: 8
- target: $.paths['/database/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List the filters the People Database supports
      effect: read
      questions:
      - Which filter ids can I use when searching the lemlist People Database?
      - What search criteria are available for finding prospects and companies?
      instructions:
      - text: Show me every filter the People Database accepts.
      - text: Fetch the database filter catalog so I can build a search.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/database/people'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the People Database for prospects
      effect: read
      questions:
      - How do I search for people matching my ideal customer profile?
      - Can I page through prospect search results for a set of filters?
      instructions:
      - text: Find people in the database matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Get page {page} of people results for {filters}.
        slots:
          page: requestBody.page
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schema/people'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the field schema for people records
      effect: read
      questions:
      - What fields come back on a person record from the People Database?
      - Where can I see the data structure of a prospect profile?
      instructions:
      - text: Show me the schema of a People Database person record.
      - text: Describe the person-record fields for filters {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/database/companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the database for companies
      effect: read
      questions:
      - How do I look up companies that match my target account criteria?
      - Can I paginate through company search results in the database?
      instructions:
      - text: Find companies in the database matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Get page {page} of company results for {filters}.
        slots:
          page: requestBody.page
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schema/companies'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the field schema for company records
      effect: read
      questions:
      - What fields does a company record in the database contain?
      - Which attributes are returned for an organization from the companies database?
      instructions:
      - text: Show me the schema of a database company record.
      - text: Describe the company-record fields for filters {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/database/personas'].get
  update:
    x-apievangelist-phrasing:
      intent: List my team's saved personas
      effect: read
      questions:
      - Which personas has my team saved in the lemlist People Database?
      - Can I see only the personas built for one search mode?
      - What reusable prospect filter sets do we already have, newest first?
      instructions:
      - text: List all the personas my team has saved.
      - text: Show our saved personas for the {mode} search mode.
        slots:
          mode: query.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/database/personas'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new persona from database filters
      effect: write
      questions:
      - How do I save a set of People Database filters as a reusable persona?
      - What happens to filters my plan doesn't include when I create a persona?
      - Does a new persona's name have to be unique within my team?
      instructions:
      - text: 'Create a persona named {name} in {mode} mode using these filters: {filters}.'
        slots:
          name: requestBody.name
          mode: requestBody.mode
          filters: requestBody.filters
      - text: Save {filters} as a new leads persona called {name}.
        slots:
          filters: requestBody.filters
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/database/personas/{personaId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a saved persona
      effect: destructive
      questions:
      - Can I remove a persona my team no longer uses?
      - Is deleting a persona reversible?
      - Why does deleting the auto-generated persona return a 404?
      instructions:
      - text: Delete persona {personaId} for good.
        slots:
          personaId: path.personaId
      - text: Remove the saved persona {personaId} from my team's list.
        slots:
          personaId: path.personaId
      method: generated
      generated: '2026-09-26'