Sign in

v1

latestOpenAPI 3.1.02026-07-17141136.0 KB
experiments

Fork experiment

Create a copy of an experiment with all its stages and agents.

Access Control: You can only fork an experiment if:

  • The experiment's visibility is set to PUBLIC, OR
  • You are the owner/creator of the experiment

The forked experiment will have:

  • A new unique ID
  • Name set to "Copy of [original name]" (or custom name if provided)
  • The current user as creator
  • All stages copied
  • All agent mediators and agent participants copied

The forked experiment will NOT include:

  • Cohorts
  • Participants
  • Any collected data
post/experiments/{id}/fork

Path parameters

idstring required

Experiment ID

Request body

namestring

Optional custom name for the forked experiment

Example request

{
  "name": "My Forked Experiment"
}

Response

Experiment forked successfully

sourceExperimentIdstring

ID of the original experiment that was forked

Example response

{
  "experiment": {
    "id": "exp123",
    "versionId": 18,
    "metadata": {
      "name": "Decision Making Study",
      "publicName": "Decision Study",
      "description": "Research on group decision making",
      "tags": [
        "research",
        "decision-making"
      ],
      "creator": "experimenter123"
    },
    "permissions": {
      "visibility": "private",
      "readers": [
        "experimenter123"
      ]
    },
    "stageIds": [
      "stage1",
      "stage2"
    ]
  },
  "sourceExperimentId": "exp123"
}