v1
latestOpenAPI 3.1.02026-08-0472428.7 KBStudies
Create a new study
Launch a new study with the given parameters. Upload file stimuli via the presigned URL endpoint first and include the resulting S3 keys as URLs. Returns a job ID for tracking study creation progress via the job status endpoint.
post/v1/studies
Request body
Example request
{
"added_captions": [
{
"content": "A new smartphone with a 6.5 inch display...",
"name": "Product description"
}
],
"age_parameters": {
"max_age": 65,
"min_age": 18
},
"assigned_materials": [
{
"materials_name": "Control",
"stimuli": [
{
"media": [
"A new smartphone with a 6.5 inch display..."
],
"stimulus_name": "Product description",
"stimulus_type": "text"
}
]
}
],
"number_participants": 50,
"question_groups": [
{
"name": "Purchase Intent",
"questions": [
"How likely are you to purchase this product?"
],
"scale": "7 point scale (1 = Not at all likely; 7 = Extremely likely)"
}
],
"research_goal": "",
"segments": [
{
"name": "Gender",
"subcategories": [
{
"name": "Male",
"percentage": 50
},
{
"name": "Female",
"percentage": 50
}
]
}
],
"title": "Example Study",
"uploaded_audios": [],
"uploaded_images": [],
"uploaded_pdfs": [],
"uploaded_videos": []
}Response
OK