Skip to main content

Providers

Crowd providers standardize access to external crowd workers, by wrapping external API communication through a standardized interface.

prolific

desttypedefaulthelpchoicesrequired
requester_namestr???NoneNoneFalse
prolific_external_study_urlstrThe external study URL of your study that you want participants to be direct to. The URL can be customized to add information to match participants in your survey. You can add query parameters with the following placeholders. Example of a link with params: https://example.com?participant_id={{%PROLIFIC_PID%}}&study_id={{%STUDY_ID%}}&submission_id={{%SESSION_ID%}}where prolific_pid, study_id, submission_id are params we use on our side, and {{%PROLIFIC_PID%}}, {{%STUDY_ID%}}, {{%SESSION_ID%}} are their format of template variables they use to replace with their IDsNoneFalse
prolific_id_optionstrurl_parametersEnum: "question" "url_parameters" "not_required". Use 'question' if you will add a question in your survey or experiment asking the participant ID. Recommended Use 'url_parameters' if your survey or experiment can retrieve and store those parameters for your analysis.Use 'not_required' if you don't need to record themNoneFalse
prolific_estimated_completion_time_in_minutesint5Estimated duration in minutes of the experiment or survey (estimated_completion_time in Prolific).NoneFalse
prolific_eligibility_requirementslist()Eligibility requirements allows you to define participants criteria such as age, gender and country.NoneFalse
prolific_workspace_namestrMy WorkspaceNoneNoneFalse
prolific_project_namestrProjectNoneNoneFalse
prolific_allow_list_group_namestrAllow listNoneNoneFalse
prolific_block_list_group_namestrBlock listNoneNoneFalse

mturk

desttypedefaulthelpchoicesrequired
requester_namestr???NoneNoneFalse

mturk sandbox

desttypedefaulthelpchoicesrequired
requester_namestr???NoneNoneFalse

inhouse

desttypedefaulthelpchoicesrequired
requester_namestr???NoneNoneFalse
ui_base_urlstrhttp://localhost:3000Base URL to task UI. Mostly needed for Docker, as hosting port may differ from container port.NoneFalse
admit_workers_with_no_prior_qualificationunknownNoneIf task has required qualifications, but worker is newly created, and this param is True, we allow this worker to complete this TaskNoneFalse
authorization_csvunknownNonePath to csv file containing list of worker namesNoneFalse

mock

desttypedefaulthelpchoicesrequired
requester_namestr???NoneNoneFalse