Skip to main content
POST
/
api
/
public
/
v1
/
studies
/
Create Study
curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/studies/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "study_type": "in-depth-interview",
  "study_plan": {
    "objectives": "<string>",
    "conversation_flow": "<string>",
    "background": "<string>",
    "learning_goals": "<string>",
    "key_questions": "<string>",
    "study_specific_rules": "<string>"
  },
  "screener_questions": [
    {
      "text": "<string>",
      "type": "single_select",
      "options": [
        {
          "text": "<string>",
          "disqualify": false,
          "id": "<string>"
        }
      ],
      "order": 123,
      "id": "<string>",
      "text_values": [
        "<string>"
      ],
      "disallowed_text_values": [
        "<string>"
      ],
      "category": "<string>"
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "byop_config": {
    "incentive_amount": 203,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  }
}
'
import requests

url = "https://api.userintuition.ai/api/public/v1/studies/"

payload = {
    "name": "<string>",
    "study_type": "in-depth-interview",
    "study_plan": {
        "objectives": "<string>",
        "conversation_flow": "<string>",
        "background": "<string>",
        "learning_goals": "<string>",
        "key_questions": "<string>",
        "study_specific_rules": "<string>"
    },
    "screener_questions": [
        {
            "text": "<string>",
            "type": "single_select",
            "options": [
                {
                    "text": "<string>",
                    "disqualify": False,
                    "id": "<string>"
                }
            ],
            "order": 123,
            "id": "<string>",
            "text_values": ["<string>"],
            "disallowed_text_values": ["<string>"],
            "category": "<string>"
        }
    ],
    "targeting_attributes": [
        {
            "qualification_id": 123,
            "allowed_options": [123],
            "disallowed_options": [123]
        }
    ],
    "byop_config": {
        "incentive_amount": 203,
        "is_incentives_enabled": True,
        "auto_send_incentives": True
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    study_type: 'in-depth-interview',
    study_plan: {
      objectives: '<string>',
      conversation_flow: '<string>',
      background: '<string>',
      learning_goals: '<string>',
      key_questions: '<string>',
      study_specific_rules: '<string>'
    },
    screener_questions: [
      {
        text: '<string>',
        type: 'single_select',
        options: [{text: '<string>', disqualify: false, id: '<string>'}],
        order: 123,
        id: '<string>',
        text_values: ['<string>'],
        disallowed_text_values: ['<string>'],
        category: '<string>'
      }
    ],
    targeting_attributes: [{qualification_id: 123, allowed_options: [123], disallowed_options: [123]}],
    byop_config: {incentive_amount: 203, is_incentives_enabled: true, auto_send_incentives: true}
  })
};

fetch('https://api.userintuition.ai/api/public/v1/studies/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userintuition.ai/api/public/v1/studies/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'study_type' => 'in-depth-interview',
    'study_plan' => [
        'objectives' => '<string>',
        'conversation_flow' => '<string>',
        'background' => '<string>',
        'learning_goals' => '<string>',
        'key_questions' => '<string>',
        'study_specific_rules' => '<string>'
    ],
    'screener_questions' => [
        [
                'text' => '<string>',
                'type' => 'single_select',
                'options' => [
                                [
                                                                'text' => '<string>',
                                                                'disqualify' => false,
                                                                'id' => '<string>'
                                ]
                ],
                'order' => 123,
                'id' => '<string>',
                'text_values' => [
                                '<string>'
                ],
                'disallowed_text_values' => [
                                '<string>'
                ],
                'category' => '<string>'
        ]
    ],
    'targeting_attributes' => [
        [
                'qualification_id' => 123,
                'allowed_options' => [
                                123
                ],
                'disallowed_options' => [
                                123
                ]
        ]
    ],
    'byop_config' => [
        'incentive_amount' => 203,
        'is_incentives_enabled' => true,
        'auto_send_incentives' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userintuition.ai/api/public/v1/studies/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"study_type\": \"in-depth-interview\",\n  \"study_plan\": {\n    \"objectives\": \"<string>\",\n    \"conversation_flow\": \"<string>\",\n    \"background\": \"<string>\",\n    \"learning_goals\": \"<string>\",\n    \"key_questions\": \"<string>\",\n    \"study_specific_rules\": \"<string>\"\n  },\n  \"screener_questions\": [\n    {\n      \"text\": \"<string>\",\n      \"type\": \"single_select\",\n      \"options\": [\n        {\n          \"text\": \"<string>\",\n          \"disqualify\": false,\n          \"id\": \"<string>\"\n        }\n      ],\n      \"order\": 123,\n      \"id\": \"<string>\",\n      \"text_values\": [\n        \"<string>\"\n      ],\n      \"disallowed_text_values\": [\n        \"<string>\"\n      ],\n      \"category\": \"<string>\"\n    }\n  ],\n  \"targeting_attributes\": [\n    {\n      \"qualification_id\": 123,\n      \"allowed_options\": [\n        123\n      ],\n      \"disallowed_options\": [\n        123\n      ]\n    }\n  ],\n  \"byop_config\": {\n    \"incentive_amount\": 203,\n    \"is_incentives_enabled\": true,\n    \"auto_send_incentives\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.userintuition.ai/api/public/v1/studies/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"study_type\": \"in-depth-interview\",\n  \"study_plan\": {\n    \"objectives\": \"<string>\",\n    \"conversation_flow\": \"<string>\",\n    \"background\": \"<string>\",\n    \"learning_goals\": \"<string>\",\n    \"key_questions\": \"<string>\",\n    \"study_specific_rules\": \"<string>\"\n  },\n  \"screener_questions\": [\n    {\n      \"text\": \"<string>\",\n      \"type\": \"single_select\",\n      \"options\": [\n        {\n          \"text\": \"<string>\",\n          \"disqualify\": false,\n          \"id\": \"<string>\"\n        }\n      ],\n      \"order\": 123,\n      \"id\": \"<string>\",\n      \"text_values\": [\n        \"<string>\"\n      ],\n      \"disallowed_text_values\": [\n        \"<string>\"\n      ],\n      \"category\": \"<string>\"\n    }\n  ],\n  \"targeting_attributes\": [\n    {\n      \"qualification_id\": 123,\n      \"allowed_options\": [\n        123\n      ],\n      \"disallowed_options\": [\n        123\n      ]\n    }\n  ],\n  \"byop_config\": {\n    \"incentive_amount\": 203,\n    \"is_incentives_enabled\": true,\n    \"auto_send_incentives\": true\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.userintuition.ai/api/public/v1/studies/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"study_type\": \"in-depth-interview\",\n  \"study_plan\": {\n    \"objectives\": \"<string>\",\n    \"conversation_flow\": \"<string>\",\n    \"background\": \"<string>\",\n    \"learning_goals\": \"<string>\",\n    \"key_questions\": \"<string>\",\n    \"study_specific_rules\": \"<string>\"\n  },\n  \"screener_questions\": [\n    {\n      \"text\": \"<string>\",\n      \"type\": \"single_select\",\n      \"options\": [\n        {\n          \"text\": \"<string>\",\n          \"disqualify\": false,\n          \"id\": \"<string>\"\n        }\n      ],\n      \"order\": 123,\n      \"id\": \"<string>\",\n      \"text_values\": [\n        \"<string>\"\n      ],\n      \"disallowed_text_values\": [\n        \"<string>\"\n      ],\n      \"category\": \"<string>\"\n    }\n  ],\n  \"targeting_attributes\": [\n    {\n      \"qualification_id\": 123,\n      \"allowed_options\": [\n        123\n      ],\n      \"disallowed_options\": [\n        123\n      ]\n    }\n  ],\n  \"byop_config\": {\n    \"incentive_amount\": 203,\n    \"is_incentives_enabled\": true,\n    \"auto_send_incentives\": true\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "study_type": "<string>",
  "recruiting_method": "<string>",
  "language": "<string>",
  "byop_config": {
    "incentive_amount": 123,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  },
  "study_link": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "study_plan": {
    "objectives": "<string>",
    "conversation_flow": "<string>",
    "background": "<string>",
    "learning_goals": "<string>",
    "key_questions": "<string>",
    "study_specific_rules": "<string>"
  },
  "screener_questions": [
    {
      "id": "<string>",
      "text": "<string>",
      "type": "<string>",
      "order": 123,
      "options": [
        {
          "id": "<string>",
          "text": "<string>",
          "disqualify": true
        }
      ],
      "text_values": [
        "<string>"
      ],
      "disallowed_text_values": [
        "<string>"
      ],
      "category": "<string>"
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "total_invites": 123,
  "total_calls": 123,
  "quality_calls": 123
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Body

application/json

Create a study. Unknown fields are rejected.

​
name
string | null

Study display name

​
study_type
string
default:in-depth-interview

Study-type template slug

Allowed value: "in-depth-interview"
​
recruiting_method
enum<string> | null

panel (recruit from the panel) or byop (bring your own participants)

Available options:
panel,
byop
​
interview_format
enum<string> | null

chat, video, or voice

Available options:
chat,
video,
voice
​
voice
enum<string> | null

Interviewer voice: male (Elliot) or female (Clara)

Available options:
male,
female
​
language
enum<string>

Interview language: an ISO 639-1 code, or 'auto' to auto-detect. Must be one of the supported options.

Available options:
auto,
ar,
bg,
cs,
da,
de,
el,
en,
es,
fi,
fil,
fr,
hi,
hr,
id,
it,
ja,
ko,
ms,
nl,
pl,
pt,
ro,
ru,
sk,
sv,
ta,
tr,
uk,
zh
​
study_plan
PublicStudyPlan · object | null

Interview instructions as named sections.

​
screener_questions
PublicScreenerQuestionInput · object[] | null
​
targeting_attributes
PublicTargetingAttribute · object[] | null

Target the panel by demographic qualifications (panel studies).

​
byop_config
PublicByopConfig · object | null

Incentive settings (BYOP only).

Response

Successful Response

Full study shape returned by get-by-id (includes the heavy fields).

​
id
string
required
​
name
string | null
​
study_type
string | null

Study-type template slug

​
recruiting_method
string | null

panel or byop

​
interview_format
enum<string> | null

chat, video, or voice

Available options:
chat,
video,
voice
​
voice
enum<string> | null

male or female

Available options:
male,
female
​
language
string | null

Interview language code, e.g. 'en'

​
byop_config
PublicByopConfigOut · object
​
study_link
string | null

Universal interview link for the study

​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null
​
study_plan
PublicStudyPlanOut · object | null

Response variant — all sections optional (a study's stored prompt may not contain every section).

​
screener_questions
PublicScreenerQuestion · object[] | null
​
targeting_attributes
PublicTargetingAttribute · object[] | null
​
total_invites
integer | null
​
total_calls
integer | null
​
quality_calls
integer | null

Number of quality interviews