Edit study with AI agent

curl -X POST https://api.getversive.com/api/v1/studies/9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b/agent \
  -H "Authorization: Bearer $VERSIVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Add a screener asking how often they cook at home; screen out people who never cook.",
    "auto_save": false
  }'

{
  "message": {},
  "mutations": [
    {}
  ],
  "questions": [
    {}
  ],
  "logic": [
    {}
  ],
  "study_settings": {},
  "broken_mentions": [
    {}
  ]
}

POST

studies

{study_id}

agent

curl -X POST https://api.getversive.com/api/v1/studies/9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b/agent \
  -H "Authorization: Bearer $VERSIVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Add a screener asking how often they cook at home; screen out people who never cook.",
    "auto_save": false
  }'

{
  "message": {},
  "mutations": [
    {}
  ],
  "questions": [
    {}
  ],
  "logic": [
    {}
  ],
  "study_settings": {},
  "broken_mentions": [
    {}
  ]
}

Sends a natural-language instruction to Versive’s study-editing agent. The agent can add, edit, delete, and reorder questions, change logic rules, and update study settings and messages. By default changes are saved immediately (with automatic rollback if anything fails); set auto_save: false to preview the mutations and apply them separately.

string

required

The study ID.

string

required

The editing instruction, e.g. “Add an NPS question after the intro and screen out anyone who scores under 3 on Q2.”

boolean

default:"true"

Persist changes before returning. Set false to preview.

string

default:"smart"

smart (higher quality) or fast (lower latency).

string

Language context for the edit.

Response

string | null

The agent’s natural-language summary of what it did.

Mutation[]

object[]

The study’s questions after the edit, each including a resolved mentions array.

object[]

The study’s logic rules after the edit.

object | null

Updated study settings, when changed.

object[]

Any {{Q:...}} references broken by the edit: question_id, placeholder, error, newly_broken.

curl -X POST https://api.getversive.com/api/v1/studies/9b2f7c1e-4a4b-4f6e-9a1d-1c2d3e4f5a6b/agent \
  -H "Authorization: Bearer $VERSIVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Add a screener asking how often they cook at home; screen out people who never cook.",
    "auto_save": false
  }'

Getting started

Studies

Questions

Question logic

Interviews

Insights

Translated questions

Folders

Edit study with AI agent

Response

​Response

Response