Playground Generate
curl --request POST \
--url https://api.example.com/api/v1/campaigns/{campaign_id}/playground/generate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step_index": 16,
"n_leads": 50,
"custom_prompt": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/campaigns/{campaign_id}/playground/generate"
payload = {
"step_index": 16,
"n_leads": 50,
"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({step_index: 16, n_leads: 50, custom_prompt: '<string>'})
};
fetch('https://api.example.com/api/v1/campaigns/{campaign_id}/playground/generate', 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/campaigns/{campaign_id}/playground/generate",
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([
'step_index' => 16,
'n_leads' => 50,
'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/campaigns/{campaign_id}/playground/generate"
payload := strings.NewReader("{\n \"step_index\": 16,\n \"n_leads\": 50,\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/campaigns/{campaign_id}/playground/generate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step_index\": 16,\n \"n_leads\": 50,\n \"custom_prompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/campaigns/{campaign_id}/playground/generate")
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 \"step_index\": 16,\n \"n_leads\": 50,\n \"custom_prompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_index": 123,
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enqueued_lead_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"prompt_version_hash": "<string>",
"total": 123
}playground
Playground Generate
Enqueue an ARQ playground_generation task per target lead.
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
playground
/
generate
Playground Generate
curl --request POST \
--url https://api.example.com/api/v1/campaigns/{campaign_id}/playground/generate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step_index": 16,
"n_leads": 50,
"custom_prompt": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/campaigns/{campaign_id}/playground/generate"
payload = {
"step_index": 16,
"n_leads": 50,
"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({step_index: 16, n_leads: 50, custom_prompt: '<string>'})
};
fetch('https://api.example.com/api/v1/campaigns/{campaign_id}/playground/generate', 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/campaigns/{campaign_id}/playground/generate",
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([
'step_index' => 16,
'n_leads' => 50,
'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/campaigns/{campaign_id}/playground/generate"
payload := strings.NewReader("{\n \"step_index\": 16,\n \"n_leads\": 50,\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/campaigns/{campaign_id}/playground/generate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step_index\": 16,\n \"n_leads\": 50,\n \"custom_prompt\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/campaigns/{campaign_id}/playground/generate")
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 \"step_index\": 16,\n \"n_leads\": 50,\n \"custom_prompt\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_index": 123,
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enqueued_lead_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"prompt_version_hash": "<string>",
"total": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
POST /campaigns/{id}/playground/generate body.
Enqueues one ARQ task per target lead. Each call creates a fresh
batch_id server-side — V1 does not coalesce spam-clicks; the client
should debounce the button. The canonical idempotency tuple
(campaign_id, campaign_lead_id, prompt_version_hash, batch_id) keeps
duplicate workers no-op via the DB-authoritative cancel/batch check.
Campaign step to generate drafts for.
Required range:
1 <= x <= 32Number of PERSONALIZATION-assigned leads to enqueue.
Required range:
1 <= x <= 200Optional override prompt; else server resolves via campaign.system_prompt -> sender.custom_prompt -> DEFAULT.
Maximum string length:
32000⌘I