Built-in tool
Start an experiment
Log a new experiment: the hypothesis, the one variable being changed, its variants, the deciding metric and the minimum sample.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| namestring · required | string | required | Short name, e.g. 'Opener: question vs statement'. Example: |
| hypothesisstring · required | string | required | What you expect to happen and why. |
| variablestring · required | string | required | The ONE thing that differs between the variants, e.g. "first message opener". Everything else stays the same. Example: |
| variantsobject · required | object | required | Two to six variants; the first is the control (what runs today). |
| primaryMetricstring · required | string | required | The one number that decides it: 'accept_rate', 'reply_rate' or 'positive_reply_rate' are measured from the outreach funnel for variants bound to Workflows, steps or senders; 'custom' is any other rate you report yourself. One of: |
| minimumSamplenumber · required | number | required | How many each variant needs in the metric's denominator (requests sent for accept_rate, conversations for reply rates) before it may be judged. |
| metricNamestring · optional | string | optional | For 'custom': what is measured, e.g. 'calls booked per positive reply'. Example: |
| scopeLabelstring · optional | string | optional | When not tied to one Workflow: the area the test occupies, e.g. 'linkedin content' or 'google ads'. One test runs per area at a time. One of: |
| workflowIdstring · optional | string | optional | The Workflow (campaign) this test runs in. One test runs per Workflow at a time. |
| ownerAgentIdstring · optional | string | optional | Agent responsible for this test. Defaults to the agent calling. |
| repeatReasonstring · optional | string | optional | Only when this tool answered that the test repeats a logged one: what has changed since, so running it again is justified. |