> ## Documentation Index
> Fetch the complete documentation index at: https://bavlio.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Find Leads



## OpenAPI

````yaml https://api.bavlio.com/openapi.json post /api/v1/lead-finding/find-leads
openapi: 3.1.0
info:
  title: Bavlio API
  description: >-
    Outreach automation API — lead enrichment, email campaigns, LinkedIn
    automation, and AI agent. Full docs at https://docs.bavlio.com.
  version: 1.0.0
  x-guidance:
    product: Bavlio Data API
    protocols:
      - x402
    description: >-
      Pay-per-call B2B data endpoints for AI agents. USDC on Base mainnet via
      x402 v2. See /openapi.json for pricing. Landing page + marketing details:
      https://bavlio.com/developers
    network: eip155:8453
    docs_url: https://docs.bavlio.com
  x-payment-merchant-address: '0xcca4725e0e931982830bff523b141e1a7a58d3e7'
servers: []
security: []
tags:
  - name: API Keys
    description: >-
      Create, list, and revoke API keys for programmatic access. JWT
      authentication required.
  - name: credits
    description: Credit balance, cost estimates, and transaction history.
  - name: campaigns
    description: Create, manage, launch, and monitor email campaigns.
  - name: campaign-personalization
    description: AI-powered email subject and body personalization for campaigns.
  - name: email-finder
    description: Find and verify email addresses for prospects.
  - name: sender-profiles
    description: Manage sender identity profiles for outreach.
  - name: sender-profile-chat
    description: Interactive chat for building sender profiles.
  - name: templates
    description: Email template CRUD.
  - name: suppression
    description: Do-not-contact suppression list management.
  - name: datasets
    description: Lead dataset listing, download, and updates.
  - name: user-extractions
    description: Uploaded lead file management and processing.
  - name: enrichment-chat
    description: Interactive chat for data enrichment sessions.
  - name: enrichment-processing
    description: Batch lead enrichment processing.
  - name: File Upload (CSV/Excel)
    description: Upload and preview CSV/Excel lead files.
  - name: connected-accounts
    description: LinkedIn account connections via Unipile.
  - name: linkedin-content
    description: LinkedIn post creation, scheduling, and management.
  - name: linkedin-playground
    description: Direct LinkedIn actions (profile lookup, messaging, engagement).
  - name: bavimail-proxy
    description: BaviMail domain, alias, and email management.
  - name: agent
    description: Bavi AI agent chat with SSE streaming.
  - name: notifications
    description: Notification preferences and delivery.
  - name: referral
    description: Referral code management and stats.
  - name: feedback
    description: User feedback submission.
  - name: authentication
    description: JWT token verification and user info.
  - name: users
    description: User quota and usage information.
  - name: Health
    description: Health checks and system status.
  - name: Personalization
    description: Core lead personalization engine.
  - name: Session Management
    description: Enrichment session lifecycle.
  - name: Session Processing
    description: Session data processing.
  - name: webhooks
    description: Inbound webhook handlers (Stripe, BaviMail, Unipile).
paths:
  /api/v1/lead-finding/find-leads:
    post:
      tags:
        - lead_finding
      summary: Find Leads
      operationId: find_leads_api_v1_lead_finding_find_leads_post
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/ImplicitFindLeadsRequest'
                - $ref: '#/components/schemas/ExplicitFindLeadsRequest'
              title: Request
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ClarificationRequiredResponse'
                  - $ref: '#/components/schemas/FindLeadsCompletedResponse'
                  - $ref: '#/components/schemas/FindLeadsInProgressResponse'
                title: Response Find Leads Api V1 Lead Finding Find Leads Post
        '401':
          description: Unauthorized
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ImplicitFindLeadsRequest:
      properties:
        query:
          type: string
          maxLength: 1000
          minLength: 1
          title: Query
        count:
          anyOf:
            - type: integer
              maximum: 500
              minimum: 1
            - type: 'null'
          title: Count
        auto_enrich:
          type: boolean
          title: Auto Enrich
          default: true
        target:
          anyOf:
            - type: string
              enum:
                - people
                - companies
            - type: 'null'
          title: Target
        idempotency_key:
          type: string
          maxLength: 180
          minLength: 1
          title: Idempotency Key
      additionalProperties: false
      type: object
      required:
        - query
        - idempotency_key
      title: ImplicitFindLeadsRequest
    ExplicitFindLeadsRequest:
      properties:
        filters:
          $ref: '#/components/schemas/LeadFilters'
        schema_version:
          type: string
          enum:
            - '1'
            - '2'
          title: Schema Version
          default: '1'
        query:
          anyOf:
            - type: string
              maxLength: 1000
              minLength: 1
            - type: 'null'
          title: Query
        auto_enrich:
          type: boolean
          title: Auto Enrich
          default: true
        target:
          anyOf:
            - type: string
              enum:
                - people
                - companies
            - type: 'null'
          title: Target
        idempotency_key:
          type: string
          maxLength: 180
          minLength: 1
          title: Idempotency Key
      additionalProperties: false
      type: object
      required:
        - filters
        - idempotency_key
      title: ExplicitFindLeadsRequest
    ClarificationRequiredResponse:
      properties:
        status:
          type: string
          const: clarification_required
          title: Status
          default: clarification_required
        question:
          type: string
          title: Question
      type: object
      required:
        - question
      title: ClarificationRequiredResponse
    FindLeadsCompletedResponse:
      additionalProperties: true
      type: object
    FindLeadsInProgressResponse:
      additionalProperties: true
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    LeadFilters:
      properties:
        count:
          anyOf:
            - oneOf:
                - $ref: '#/components/schemas/ScalarNumericFilter-Input'
                - $ref: '#/components/schemas/BetweenNumericFilter-Input'
              discriminator:
                propertyName: operator
                mapping:
                  between: '#/components/schemas/BetweenNumericFilter-Input'
                  eq: '#/components/schemas/ScalarNumericFilter-Input'
                  gt: '#/components/schemas/ScalarNumericFilter-Input'
                  gte: '#/components/schemas/ScalarNumericFilter-Input'
                  lt: '#/components/schemas/ScalarNumericFilter-Input'
                  lte: '#/components/schemas/ScalarNumericFilter-Input'
            - type: 'null'
          title: Count
        title:
          anyOf:
            - type: string
              maxLength: 1000
              minLength: 1
            - type: 'null'
          title: Title
        schools:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Schools
        industry:
          anyOf:
            - type: string
              maxLength: 1000
              minLength: 1
            - type: 'null'
          title: Industry
        categories:
          anyOf:
            - $ref: '#/components/schemas/TextCriterion'
            - type: 'null'
        location:
          anyOf:
            - type: string
              maxLength: 1000
              minLength: 1
            - type: 'null'
          title: Location
        radius:
          anyOf:
            - anyOf:
                - type: integer
                - type: number
              gt: 0
            - type: 'null'
          title: Radius
        radius_unit:
          anyOf:
            - type: string
              enum:
                - mi
                - km
            - type: 'null'
          title: Radius Unit
        company:
          anyOf:
            - type: string
              maxLength: 1000
              minLength: 1
            - type: 'null'
          title: Company
        domain:
          anyOf:
            - type: string
              maxLength: 1000
              minLength: 1
            - type: 'null'
          title: Domain
        keywords:
          anyOf:
            - type: string
              maxLength: 240
              minLength: 1
            - type: 'null'
          title: Keywords
        seniority:
          anyOf:
            - type: string
              maxLength: 1000
              minLength: 1
            - type: 'null'
          title: Seniority
        function:
          anyOf:
            - type: string
              maxLength: 1000
              minLength: 1
            - type: 'null'
          title: Function
        annual_revenue:
          anyOf:
            - oneOf:
                - $ref: '#/components/schemas/ScalarRevenueFilter-Input'
                - $ref: '#/components/schemas/BetweenRevenueFilter'
              discriminator:
                propertyName: operator
                mapping:
                  between: '#/components/schemas/BetweenRevenueFilter'
                  eq: '#/components/schemas/ScalarRevenueFilter-Input'
                  gt: '#/components/schemas/ScalarRevenueFilter-Input'
                  gte: '#/components/schemas/ScalarRevenueFilter-Input'
                  lt: '#/components/schemas/ScalarRevenueFilter-Input'
                  lte: '#/components/schemas/ScalarRevenueFilter-Input'
            - type: 'null'
          title: Annual Revenue
        headcount:
          anyOf:
            - oneOf:
                - $ref: '#/components/schemas/ScalarNumericFilter-Input'
                - $ref: '#/components/schemas/BetweenNumericFilter-Input'
              discriminator:
                propertyName: operator
                mapping:
                  between: '#/components/schemas/BetweenNumericFilter-Input'
                  eq: '#/components/schemas/ScalarNumericFilter-Input'
                  gt: '#/components/schemas/ScalarNumericFilter-Input'
                  gte: '#/components/schemas/ScalarNumericFilter-Input'
                  lt: '#/components/schemas/ScalarNumericFilter-Input'
                  lte: '#/components/schemas/ScalarNumericFilter-Input'
            - type: 'null'
          title: Headcount
        funding_stage:
          anyOf:
            - type: string
              maxLength: 1000
              minLength: 1
            - type: 'null'
          title: Funding Stage
      additionalProperties: false
      type: object
      title: LeadFilters
      description: Closed v1 parsed form shared by parse and execution.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ScalarNumericFilter-Input:
      properties:
        operator:
          type: string
          enum:
            - eq
            - lt
            - gt
            - lte
            - gte
          title: Operator
        value:
          type: string
          title: Value
      additionalProperties: false
      type: object
      required:
        - operator
        - value
      title: ScalarNumericFilter
    BetweenNumericFilter-Input:
      properties:
        operator:
          type: string
          const: between
          title: Operator
        value:
          $ref: '#/components/schemas/NumericBetweenValue'
      additionalProperties: false
      type: object
      required:
        - operator
        - value
      title: BetweenNumericFilter
    TextCriterion:
      properties:
        values:
          items:
            type: string
          type: array
          maxItems: 20
          minItems: 1
          title: Values
        match:
          type: string
          enum:
            - any
            - all
          title: Match
          default: any
      additionalProperties: false
      type: object
      required:
        - values
      title: TextCriterion
    ScalarRevenueFilter-Input:
      properties:
        operator:
          type: string
          enum:
            - eq
            - lt
            - gt
            - lte
            - gte
          title: Operator
        value:
          type: string
          title: Value
        currency:
          anyOf:
            - type: string
              const: USD
            - type: 'null'
          title: Currency
      additionalProperties: false
      type: object
      required:
        - operator
        - value
      title: ScalarRevenueFilter
    BetweenRevenueFilter:
      properties:
        operator:
          type: string
          const: between
          title: Operator
        value:
          $ref: '#/components/schemas/NumericBetweenValue'
        currency:
          anyOf:
            - type: string
              const: USD
            - type: 'null'
          title: Currency
      additionalProperties: false
      type: object
      required:
        - operator
        - value
      title: BetweenRevenueFilter
    NumericBetweenValue:
      properties:
        min:
          type: string
          title: Min
        max:
          type: string
          title: Max
      additionalProperties: false
      type: object
      required:
        - min
        - max
      title: NumericBetweenValue
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.