API ReferenceProjects

Create a project

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

Authentication

AuthorizationToken

Header authentication of the form Token <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.

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.

Errors