Sign in
experiments

Start Experiment

Start an experiment. (Only an experiment in 'draft' status can be started.)

post/api/v1/experiments/{experiment_id}/start

Path parameters

experiment_idinteger required

Response

Successful Response

warningsstring[]

Things that weaken the result without invalidating it, such as a variant whose agent does not pin a prompt version, so that the prompt can be edited while the experiment runs

Example response

{
  "experiment": {
    "id": 1,
    "name": "Shorter greeting",
    "target_id": 1,
    "variants": [
      {
        "id": 1,
        "name": "b",
        "weight": 50,
        "agent_id": 1,
        "agent_name": "Front desk"
      }
    ],
    "target": {
      "id": 1,
      "target": "+19995551234",
      "channel_id": 1,
      "channel_name": "Main line"
    }
  }
}

Changes

Changed in 1 of the 144 revisions of this API.1

Of the 144 revisions, 1 has no diff computed.