curl -X POST https://api.getversive.com/api/v1/studies \
-H "Authorization: Bearer $VERSIVE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Onboarding feedback — July",
"description": "Post-onboarding interview for new signups",
"welcome_message": {
"title": "Quick chat about your first week?",
"body": "This takes about 5 minutes.",
"ctaText": "Start"
}
}'
{
"id": "9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b",
"title": "Onboarding feedback — July",
"description": "Post-onboarding interview for new signups",
"metadata": null,
"type": "VERSIVE_STUDY",
"mode": "TEXT_AND_VOICE",
"access_policy": "FULL_ACCESS",
"config": { "interviewMode": "quality", "lang": { "default": { "name": "English" } } },
"welcome_message": {
"title": "Quick chat about your first week?",
"body": "This takes about 5 minutes.",
"ctaText": "Start"
},
"thank_you_message": null,
"screen_out_message": { "title": "Thanks for your interest!" },
"created_at": "2026-07-13T10:30:00Z"
}
Studies
Create study
Create a new study
POST
/
studies
curl -X POST https://api.getversive.com/api/v1/studies \
-H "Authorization: Bearer $VERSIVE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Onboarding feedback — July",
"description": "Post-onboarding interview for new signups",
"welcome_message": {
"title": "Quick chat about your first week?",
"body": "This takes about 5 minutes.",
"ctaText": "Start"
}
}'
{
"id": "9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b",
"title": "Onboarding feedback — July",
"description": "Post-onboarding interview for new signups",
"metadata": null,
"type": "VERSIVE_STUDY",
"mode": "TEXT_AND_VOICE",
"access_policy": "FULL_ACCESS",
"config": { "interviewMode": "quality", "lang": { "default": { "name": "English" } } },
"welcome_message": {
"title": "Quick chat about your first week?",
"body": "This takes about 5 minutes.",
"ctaText": "Start"
},
"thank_you_message": null,
"screen_out_message": { "title": "Thanks for your interest!" },
"created_at": "2026-07-13T10:30:00Z"
}
Creates a study in your organization. Versive applies sensible default configuration (interview mode, messages, screen-out defaults) and merges any
config you provide over those defaults.
string
required
The study title.
string
Internal description of the study.
string
default:"VERSIVE_STUDY"
Study type. Use
VERSIVE_STUDY (default) for AI-moderated studies.string
default:"TEXT_AND_VOICE"
Conversation mode:
TEXT_ONLY, TEXT_AND_VOICE, VOICE_WITH_PREVIEW, or VIDEO.string
default:"FULL_ACCESS"
Controls which organization members can access the study. Use
FULL_ACCESS, CAN_EDIT,
CAN_EDIT_SURVEY_ONLY, CAN_VIEW, or INVITE_ONLY. This does not control participant access.object
Study configuration overrides, merged over Versive’s defaults (AI interviewer settings, branding, languages, device rules, and so on).Branding you omit here is filled in from your organization’s study branding defaults; branding you send explicitly is kept as-is.
object
Welcome screen:
{ title, body, ctaText }.object
Completion screen:
{ title, body, ctaText, ctaLink }.object
Screen-out screen:
{ title, body, ctaText, ctaLink }. A default is applied if omitted.string
Folder to create the study in.
object
Arbitrary key/value metadata stored on the study.
object
Insights configuration (e.g. analysis model).
Response
Returns the created study (status201) with fields: id, title, description, metadata, type, mode, config, welcome_message, thank_you_message, screen_out_message, access_policy, and created_at.
curl -X POST https://api.getversive.com/api/v1/studies \
-H "Authorization: Bearer $VERSIVE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"title": "Onboarding feedback — July",
"description": "Post-onboarding interview for new signups",
"welcome_message": {
"title": "Quick chat about your first week?",
"body": "This takes about 5 minutes.",
"ctaText": "Start"
}
}'
{
"id": "9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b",
"title": "Onboarding feedback — July",
"description": "Post-onboarding interview for new signups",
"metadata": null,
"type": "VERSIVE_STUDY",
"mode": "TEXT_AND_VOICE",
"access_policy": "FULL_ACCESS",
"config": { "interviewMode": "quality", "lang": { "default": { "name": "English" } } },
"welcome_message": {
"title": "Quick chat about your first week?",
"body": "This takes about 5 minutes.",
"ctaText": "Start"
},
"thank_you_message": null,
"screen_out_message": { "title": "Thanks for your interest!" },
"created_at": "2026-07-13T10:30:00Z"
}