Sign in

v5

latestOpenAPI 3.1.02026-08-04121440441.5 KB
studies

Show Study predicted recruitment time

Returns the predicted recruitment time for a study that has not even been saved as a draft if it was published right now, based on a machine learning model. The recruitment time is the time from publish to the time when the final participant starts their submission. It does not account for the time to complete the submission.

post/api/v1/studies/predicted-recruitment-time/

Headers

Authorizationstring required

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

Request body

workspace_idstring required

The ID of the workspace the study will be created in.

rewardnumber double required

How much are you going to pay the participants in cents. We use the currency of the workspace

study_type'SINGLE' | 'UK_REP_SAMPLE' | 'REP_SAMPLE_UK_ENGLISH_AGE_POLITICAL_AFFILIATION_ETHNICITY' | 'REP_SAMPLE_UK_ENGLISH_AGE_POLITICAL_AFFILIATION' | 'US_REP_SAMPLE' | 'REP_SAMPLE_US_ENGLISH_AGE_POLITICAL_AFFILIATION_ETHNICITY' | 'REP_SAMPLE_US_ENGLISH_AGE_POLITICAL_AFFILIATION' | 'UK_REGIONAL_REP_SAMPLE' | 'US_REGIONAL_REP_SAMPLE' required

Type of study.

total_available_placesnumber double required

How many participants are you looking to recruit

estimated_completion_timeinteger required

Estimated duration in minutes of the experiment or survey

device_compatibilityStudyPredictedRecruitmentTimeRequestDeviceCompatibilityItems[]

Add all devices that participants can use. You can include one or more options.

peripheral_requirementsStudyPredictedRecruitmentTimeRequestPeripheralRequirementsItems[]

Add all requirements that participants have to meet.

study_labels'survey' | 'writing_task' | 'annotation' | 'decision_making_task' | 'interview' | 'other' | 'ai_annotation' | 'ai_evaluation' | 'ai_reasoning' | 'ai_fact_checking' | 'ai_safety' | 'ai_data_creation_text' | 'ai_data_creation_audio' | 'ai_data_creation_video' | 'ai_data_creation_images' | 'ai_other'

The field that the study is about to get tagged with.

Response

Return the predicted recruitment time for the study

precise_recruitment_time_hoursnumber double

The predicted recruitment time in hours

lower_bound_hoursnumber double

The lower bound of the predicted recruitment time in hours

upper_bound_hoursnumber double

The upper bound of the predicted recruitment time in hours

display_stringstring

A human-readable string representing the predicted recruitment time

limit_atnumber double

The limit at which the accuracy of the prediction becomes unstable. This should be used when rendering the recruitment times in a GUI. For example if the limit_at is 10, and the predicted recruitment time is 12 hours, the display string should be "10 hours+". This has been done for you in the display_string field.