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>"
}
'import requests
url = "https://api.example.com/api/v1/personalize/preview/batch"
payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.example.com/api/v1/personalize/preview/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/personalize/preview/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/personalize/preview/batch"
payload := strings.NewReader("{\n \"client_run_id\": \"<string>\",\n \"leads\": [\n {\n \"lead_data\": {},\n \"dataset_id\": \"<string>\",\n \"row_index\": 1,\n \"force_refresh_research\": false\n }\n ],\n \"sender_profile_id\": \"<string>\",\n \"sender_data\": {},\n \"active_prompt_name\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/personalize/preview/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_run_id\": \"<string>\",\n \"leads\": [\n {\n \"lead_data\": {},\n \"dataset_id\": \"<string>\",\n \"row_index\": 1,\n \"force_refresh_research\": false\n }\n ],\n \"sender_profile_id\": \"<string>\",\n \"sender_data\": {},\n \"active_prompt_name\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/personalize/preview/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_run_id\": \"<string>\",\n \"leads\": [\n {\n \"lead_data\": {},\n \"dataset_id\": \"<string>\",\n \"row_index\": 1,\n \"force_refresh_research\": false\n }\n ],\n \"sender_profile_id\": \"<string>\",\n \"sender_data\": {},\n \"active_prompt_name\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}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.
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>"
}
'import requests
url = "https://api.example.com/api/v1/personalize/preview/batch"
payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.example.com/api/v1/personalize/preview/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/personalize/preview/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/personalize/preview/batch"
payload := strings.NewReader("{\n \"client_run_id\": \"<string>\",\n \"leads\": [\n {\n \"lead_data\": {},\n \"dataset_id\": \"<string>\",\n \"row_index\": 1,\n \"force_refresh_research\": false\n }\n ],\n \"sender_profile_id\": \"<string>\",\n \"sender_data\": {},\n \"active_prompt_name\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/personalize/preview/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_run_id\": \"<string>\",\n \"leads\": [\n {\n \"lead_data\": {},\n \"dataset_id\": \"<string>\",\n \"row_index\": 1,\n \"force_refresh_research\": false\n }\n ],\n \"sender_profile_id\": \"<string>\",\n \"sender_data\": {},\n \"active_prompt_name\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/personalize/preview/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"client_run_id\": \"<string>\",\n \"leads\": [\n {\n \"lead_data\": {},\n \"dataset_id\": \"<string>\",\n \"row_index\": 1,\n \"force_refresh_research\": false\n }\n ],\n \"sender_profile_id\": \"<string>\",\n \"sender_data\": {},\n \"active_prompt_name\": \"<string>\",\n \"custom_prompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Batch preview request body. Streams results as SSE.
Client-generated UUIDv4; backend echoes it as batch_id in every event.
1Show child attributes
Show child attributes
Saved sender profile id; takes precedence over sender_data.
Inline sender profile data; ignored if sender_profile_id is set.
Name of a named prompt stored on sender_data.prompts[]. Silent fallback to custom_prompt → default if not found.
Optional prompt override for this batch run (100-5000 chars).
Response
Successful Response