Sign in

v1

latestOpenAPI 3.1.02026-07-17141136.0 KB
cohorts

Create cohort

Create a new cohort within an experiment.

The cohort will be initialized with:

  • Public stage data for all stages
  • Generated variables based on experiment's variableConfigs
  • Stage unlock map based on stage progression requirements
  • Mediators assigned to the cohort
post/experiments/{experimentId}/cohorts

Path parameters

experimentIdstring required

Experiment ID

Request body

namestring required

Cohort name

descriptionstring

Cohort description

Example request

{
  "name": "Cohort A",
  "description": "Control group",
  "participantConfig": {
    "minParticipantsPerCohort": 1,
    "maxParticipantsPerCohort": 10,
    "showStageDescriptions": true
  }
}

Response

Cohort created successfully

Example response

{
  "cohort": {
    "id": "cohort123",
    "metadata": {
      "name": "Decision Making Study",
      "publicName": "Decision Study",
      "description": "Research on group decision making",
      "tags": [
        "research",
        "decision-making"
      ],
      "creator": "experimenter123"
    },
    "participantConfig": {
      "minParticipantsPerCohort": 1,
      "maxParticipantsPerCohort": 10,
      "showStageDescriptions": true
    },
    "stageUnlockMap": {
      "stage1": true,
      "stage2": false
    },
    "variableMap": {
      "condition": "control"
    }
  }
}