Create survey
create_surveyCreate a new survey. Nothing is sent to anyone yet: afterwards, share it with create_shared_link or invite_participant.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| goal | No | One or two sentences on what the organisation wants to learn. The interviewer reads it to steer its questions. | |
| name | Yes | Name of the survey, e.g. "Helpdesk Q4". 1 to 255 characters. | |
| themes | No | Subjects the interviewer should explore, e.g. ["Communication", "Workload"]. Three to five is typical; add more later with add_theme. | |
| scale_max | No | Highest point of the scale, greater than scale_min. Required when metric_type is scale. | |
| scale_min | No | Lowest point of the scale. Required when metric_type is scale; the range scale_min..scale_max spans at most 20 points. | |
| metric_type | Yes | The score every interview opens with. One of: nps (Net Promoter Score), enps (employee NPS), csat (customer satisfaction), ces (customer effort score), scale (a custom numeric range, which needs scale_min and scale_max). | |
| interview_locale | Yes | Language the AI interviewer speaks. One of: nl, en, de, fr, es, it, pl, pt, or auto to follow each participant's browser language. | |
| anonymous_responses | No | If true, answers are never linked to who gave them, permanently. |