Create a project | Prolific API

curl -X POST https://api.prolific.com/api/v1/workspaces/60a42f4c693c29420793cb73/projects/ \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "title": "My new project",
  "description": "Organise my next batch of studies"
}'

{
  "id": "62fce6fff0a78eb4f3ebc09c",
  "title": "My new project",
  "type": "PRIVATE",
  "description": "Organise my next batch of studies",
  "owner": "60a42f4c693c29420793cb73",
  "public_details": null,
  "users": [
    {
      "id": "60a42f4c693c29420793cb73",
      "name": "Joe Soap",
      "email": "joe.soap@gmail.com",
      "roles": [
        "PROJECT_EDITOR"
      ]
    }
  ],
  "workspace": "60a42f4c693c29420793cb73",
  "naivety_distribution_rate": 0.5
}

Creates a new project within the workspace. When this project is created, it adds the user as a Project Editor. Set type to PUBLIC to create a public project.

Authentication

AuthorizationToken

The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.

Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.

If your token is leaked, delete it and create a new one directly in the app.

In your requests add Authorization header with the value Token <your token>.

Path parameters

workspace_idstringRequired

Workspace id

Request

This endpoint expects an object.

titlestringRequired

Name of project

descriptionstringOptional

What is this project used for

typeenumOptionalDefaults to PRIVATE

Project visibility type. Set to PUBLIC to enable participant-facing public project metadata.

Allowed values:

public_detailsobject or nullOptional

Public metadata exposed for PUBLIC projects. Omit for PRIVATE projects. When creating a public project, status defaults to ENABLED.

is_longitudinalbooleanOptionalDefaults to false

Whether this is a longitudinal (multi-wave) project. Defaults to false. Longitudinal projects must be PUBLIC. Omit type entirely and it will default to PUBLIC automatically when this is true, rather than falling through to type’s own PRIVATE default.

longitudinalobject or nullOptional

Longitudinal configuration. Only used when is_longitudinal is true. waves may not be set at creation — add studies via POST /api/v1/projects/{project_id}/studies/ after creation.

naivety_distribution_ratedouble or nullOptional0-1Deprecated

Control the balance between speed of your studies and the naivety of the participants.

If not defined, by default Prolific calculates the best rate for most studies taking into account the filters and the total_available_places needed for this study.

Use 0 if your priority is speed. When this property is set to 0 all eligible participants will have access to your study at the same time, without any prioritization.

You can also set this at a workspace and study level.

Response

Successfully created project.

idstring

Project id. It is created by Prolific.

titlestring

Name of project

typeenum

Project visibility type.

Allowed values:

descriptionstringOptional

What is this project used for

ownerstringOptional

User id of the creator of the project. It is created by Prolific.

public_detailsobject or nullOptional

Public metadata for PUBLIC projects. null for PRIVATE projects.

userslist of objectsOptional

Data for all users who have access to this project

workspacestringOptional

Id of the workspace this project is in. This is created by Prolific.

is_longitudinalbooleanOptional

Whether this is a longitudinal (multi-wave) project.

longitudinalobject or nullOptional

Only present when is_longitudinal is true.

naivety_distribution_ratedouble or nullOptional0-1Deprecated

The rate at which the studies within this project are distributed.

Errors

4XX

Client Request Error