Create a project | Prolific API

Creates a new project within the workspace. When this project is created, it adds the user as a Project Editor.

Authentication

Authorizationstring

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>.

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

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.

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

descriptionstring or null

What is this project used for

ownerstring or null

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

userslist of objects or null

Data for all users who have access to this project

workspacestring or null

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

naivety_distribution_ratedouble or null0-1Deprecated

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

1	curl -X POST https://api.prolific.com/api/v1/workspaces/workspace_id/projects/ \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"title": "My new project"
6	}'

1	{
2	"id": "62fce6fff0a78eb4f3ebc09c",
3	"title": "My project",
4	"description": "This project is for...",
5	"owner": "60a42f4c693c29420793cb73",
6	"users": [
7	{
8	"id": "60a42f4c693c29420793cb73",
9	"name": "Joe Soap",
10	"email": "joe.soap@gmail.com",
11	"roles": [
12	"PROJECT_EDITOR"
13	]
14	}
15	],
16	"workspace": "60a42f4c693c29420793cb73",
17	"naivety_distribution_rate": 0.5
18	}

Authentication

Path Parameters

Request

Response

Errors