> ## 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.

# Batch preview (SSE) — up to 25 leads, streams results as they complete

> Serial backend processing (no gather) to keep per-lead cache behavior predictable and budget-flat. Streams one SSE `lead_result` event per lead and a final `done` event. Echoes `client_run_id` as `batch_id` on every event so frontends can discard stale events from prior runs.



## OpenAPI

````yaml https://api.bavlio.com/openapi.json post /api/v1/personalize/preview/batch
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
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: email-verification
    description: Validate email addresses and prune invalid entries from datasets.
  - 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: Google OAuth
    description: Google OAuth login flow and access tokens.
  - name: Google Sheets OAuth
    description: Google Sheets import and access management.
  - name: stripe
    description: Stripe checkout, billing portal, and subscription status. JWT only.
  - 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/personalize/preview/batch:
    post:
      tags:
        - Personalization
      summary: Batch preview (SSE) — up to 25 leads, streams results as they complete
      description: >-
        Serial backend processing (no gather) to keep per-lead cache behavior
        predictable and budget-flat. Streams one SSE `lead_result` event per
        lead and a final `done` event. Echoes `client_run_id` as `batch_id` on
        every event so frontends can discard stale events from prior runs.
      operationId: personalize_preview_batch_api_v1_personalize_preview_batch_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchPreviewRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    BatchPreviewRequest:
      properties:
        client_run_id:
          type: string
          title: Client Run Id
          description: >-
            Client-generated UUIDv4; backend echoes it as batch_id in every
            event.
        leads:
          items:
            $ref: '#/components/schemas/BatchPreviewLead'
          type: array
          minItems: 1
          title: Leads
        sender_profile_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Sender Profile Id
          description: Saved sender profile id; takes precedence over sender_data.
        sender_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Sender Data
          description: Inline sender profile data; ignored if sender_profile_id is set.
        active_prompt_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Prompt Name
          description: >-
            Name of a named prompt stored on sender_data.prompts[]. Silent
            fallback to custom_prompt → default if not found.
        custom_prompt:
          anyOf:
            - type: string
            - type: 'null'
          title: Custom Prompt
          description: Optional prompt override for this batch run (100-5000 chars).
      type: object
      required:
        - client_run_id
        - leads
      title: BatchPreviewRequest
      description: Batch preview request body. Streams results as SSE.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    BatchPreviewLead:
      properties:
        lead_data:
          additionalProperties: true
          type: object
          title: Lead Data
          description: Lead fields (company, role, linkedin_url, ...).
        dataset_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Dataset Id
          description: Optional dataset id for per-lead research cache.
        row_index:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Row Index
          description: Row index within dataset; required when dataset_id is set.
        force_refresh_research:
          type: boolean
          title: Force Refresh Research
          description: Bypass the research cache for this lead.
          default: false
      type: object
      required:
        - lead_data
      title: BatchPreviewLead
      description: One lead within a batch preview request.
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````