start_silicon_sample_run
Start a Silicon Sample run with confirm: true: LLM personas answer the survey and their answers are saved as responses labeled silicon_sample, alongside real respondents' data. It spends the configured LLM credential's real API budget. Track it with read_silicon_sample include job or wait. Requires a Pro plan (or a workspace with a Pro owner).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"survey_id": "<survey_id>",
"confirm": "<confirm>",
"llm_credential_id": "<llm_credential_id>"
},
"name": "start_silicon_sample_run"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true. Starting a run spends the configured LLM credential's real API budget and writes persona-generated rows into this survey's live response data, alongside genuine respondent submissions. | |
| context | No | Free-text description of the population or extra instructions added to every persona's prompt. Without a panel it defaults to "General survey respondents". | |
| panel_id | No | Build personas from a saved panel's stored respondent records (Panels in the workspace). Cannot be combined with source_survey_id. | |
| parallel | No | How many personas run at the same time (1–16, default 1). | |
| survey_id | Yes | Survey UUID | |
| column_slots | No | Panel personas only: panel column name → the demographic it holds, so the persona intro can phrase it (e.g. {"Q3_age": "age"}). Slotted columns are left out of the question-and-answer lines. | |
| persona_count | No | How many personas to run (1–5000, default 10); with a panel or earlier survey, the size of the random respondent sample. | |
| save_as_draft | No | Also save these run settings as the survey's shared Silicon Sample draft (default false). | |
| intro_template | No | With a panel: the persona's opening sentence, with {{column name}} tokens filled from that respondent's record. Blank builds one from column_slots. | |
| include_columns | No | With a panel: the panel column names to describe each persona with (default every stored column). | |
| prompt_overrides | No | Global template overrides; omit fields to retain defaults | |
| qa_line_template | No | How each remaining answer is written into the persona, with {{question}} and {{answer}} tokens. Default: To the question "{{question}}," you responded, "{{answer}}." | |
| source_survey_id | No | Build personas from the responses to an earlier survey (read_survey lists surveys). Requires source_question_ids; cannot be combined with panel_id. | |
| llm_credential_id | Yes | Saved LLM credential UUID (read_silicon_sample include credentials lists them); the API key itself stays in the app. | |
| source_question_ids | No | With source_survey_id: the earlier survey's question UUIDs whose answers describe each persona. | |
| source_response_ids | No | With panel_id or source_survey_id: use exactly these respondents (record or response ids). Takes precedence over use_all_respondents and persona_count. | |
| use_all_respondents | No | With panel_id or source_survey_id: use every respondent instead of a random sample of persona_count. Ignored when source_response_ids is set. | |
| exclude_previously_used | No | With a panel: skip panel records already used by an earlier run on this survey (default true). | |
| question_prompt_overrides | No | Overrides for how questions are rendered into the answer prompt |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |