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.

POST /api/v1/personalize/preview/batch

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

cURL

curl --request POST \
  --url https://api.example.com/api/v1/personalize/preview/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_run_id": "<string>",
  "leads": [
    {
      "lead_data": {},
      "dataset_id": "<string>",
      "row_index": 1,
      "force_refresh_research": false
    }
  ],
  "sender_profile_id": "<string>",
  "sender_data": {},
  "active_prompt_name": "<string>",
  "custom_prompt": "<string>"
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Batch preview request body. Streams results as SSE.

client_run_id · string · required

Client-generated UUIDv4; backend echoes it as batch_id in every event.

leads · BatchPreviewLead · object[] · required

Minimum array length: 1

Show child attributes

sender_profile_id · string | null

Saved sender profile id; takes precedence over sender_data.

sender_data · Sender Data · object

Inline sender profile data; ignored if sender_profile_id is set.

active_prompt_name · string | null

Name of a named prompt stored on sender_data.prompts[]. Silent fallback to custom_prompt → default if not found.

custom_prompt · string | null

Optional prompt override for this batch run (100-5000 chars).

Response

200

application/json

Successful Response