Sign in
experiments

Create experiment

Create a new experiment with specified configuration.

Supports two modes:

1. Simple creation: Provide name (required), description, stages, prolificConfig. This is the easiest way to create a basic experiment.

2. Full template creation: Provide a complete template object (ExperimentTemplate). This creates the experiment with all stages and agents, using the same logic as the UI. Other fields are ignored when template is provided.

post/experiments

Request body

namestring

(Simple creation) Experiment name - required unless template provided

descriptionstring

(Simple creation) Experiment description

prolificRedirectCodestring

(Simple creation) Prolific completion redirect code

stagesStage[] — unresolved $ref

(Simple creation) Array of stage configurations

agentMediatorsobject[]

(Simple creation) Array of agent mediator templates. Each agent includes persona config and a promptMap with stage-specific prompts.

agentParticipantsobject[]

(Simple creation) Array of agent participant templates. Each agent includes persona config and a promptMap with stage-specific prompts.

templateobject

(Full template creation) Complete ExperimentTemplate object. When provided, creates experiment with all stages and agents. All other fields are ignored.

Response

Experiment created successfully

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"
    ]
  }
}

Changes