Create Study And Launch Panel
Preview a Panel study without creating or fielding it. Paid launch requires a persisted study and a current estimate from the two-step launch flow.
curl --request POST \
--url https://api.userintuition.ai/api/public/v1/studies/create-and-launch-panel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"study": {
"name": "Startup CEO AI tool shortlist",
"study_type": "in-depth-interview",
"recruiting_method": "panel",
"interview_format": "voice",
"voice": "male",
"language": "en",
"expected_duration_seconds": 1200,
"study_plan": {
"objectives": "Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.",
"conversation_flow": "Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.",
"background": "Research into the earliest evaluation stage for AI research tools."
},
"targeting_attributes": [
{
"qualification_id": 89,
"allowed_options": [
1
],
"disallowed_options": []
}
],
"screener_questions": [
{
"text": "Are you the founder or CEO of a startup?",
"type": "single_select",
"options": [
{
"text": "Yes",
"disqualify": false
},
{
"text": "No",
"disqualify": true
}
]
}
]
},
"panel": {
"target": 20,
"incident_rate": 25,
"country_code": "US",
"frequency": "one-time",
"dry_run": true
}
}
'import requests
url = "https://api.userintuition.ai/api/public/v1/studies/create-and-launch-panel"
payload = {
"study": {
"name": "Startup CEO AI tool shortlist",
"study_type": "in-depth-interview",
"recruiting_method": "panel",
"interview_format": "voice",
"voice": "male",
"language": "en",
"expected_duration_seconds": 1200,
"study_plan": {
"objectives": "Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.",
"conversation_flow": "Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.",
"background": "Research into the earliest evaluation stage for AI research tools."
},
"targeting_attributes": [
{
"qualification_id": 89,
"allowed_options": [1],
"disallowed_options": []
}
],
"screener_questions": [
{
"text": "Are you the founder or CEO of a startup?",
"type": "single_select",
"options": [
{
"text": "Yes",
"disqualify": False
},
{
"text": "No",
"disqualify": True
}
]
}
]
},
"panel": {
"target": 20,
"incident_rate": 25,
"country_code": "US",
"frequency": "one-time",
"dry_run": 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({
study: {
name: 'Startup CEO AI tool shortlist',
study_type: 'in-depth-interview',
recruiting_method: 'panel',
interview_format: 'voice',
voice: 'male',
language: 'en',
expected_duration_seconds: 1200,
study_plan: {
objectives: 'Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.',
conversation_flow: 'Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.',
background: 'Research into the earliest evaluation stage for AI research tools.'
},
targeting_attributes: [{qualification_id: 89, allowed_options: [1], disallowed_options: []}],
screener_questions: [
{
text: 'Are you the founder or CEO of a startup?',
type: 'single_select',
options: [{text: 'Yes', disqualify: false}, {text: 'No', disqualify: true}]
}
]
},
panel: {
target: 20,
incident_rate: 25,
country_code: 'US',
frequency: 'one-time',
dry_run: true
}
})
};
fetch('https://api.userintuition.ai/api/public/v1/studies/create-and-launch-panel', 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/create-and-launch-panel",
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([
'study' => [
'name' => 'Startup CEO AI tool shortlist',
'study_type' => 'in-depth-interview',
'recruiting_method' => 'panel',
'interview_format' => 'voice',
'voice' => 'male',
'language' => 'en',
'expected_duration_seconds' => 1200,
'study_plan' => [
'objectives' => 'Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.',
'conversation_flow' => 'Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.',
'background' => 'Research into the earliest evaluation stage for AI research tools.'
],
'targeting_attributes' => [
[
'qualification_id' => 89,
'allowed_options' => [
1
],
'disallowed_options' => [
]
]
],
'screener_questions' => [
[
'text' => 'Are you the founder or CEO of a startup?',
'type' => 'single_select',
'options' => [
[
'text' => 'Yes',
'disqualify' => false
],
[
'text' => 'No',
'disqualify' => true
]
]
]
]
],
'panel' => [
'target' => 20,
'incident_rate' => 25,
'country_code' => 'US',
'frequency' => 'one-time',
'dry_run' => 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/create-and-launch-panel"
payload := strings.NewReader("{\n \"study\": {\n \"name\": \"Startup CEO AI tool shortlist\",\n \"study_type\": \"in-depth-interview\",\n \"recruiting_method\": \"panel\",\n \"interview_format\": \"voice\",\n \"voice\": \"male\",\n \"language\": \"en\",\n \"expected_duration_seconds\": 1200,\n \"study_plan\": {\n \"objectives\": \"Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.\",\n \"conversation_flow\": \"Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.\",\n \"background\": \"Research into the earliest evaluation stage for AI research tools.\"\n },\n \"targeting_attributes\": [\n {\n \"qualification_id\": 89,\n \"allowed_options\": [\n 1\n ],\n \"disallowed_options\": []\n }\n ],\n \"screener_questions\": [\n {\n \"text\": \"Are you the founder or CEO of a startup?\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"text\": \"Yes\",\n \"disqualify\": false\n },\n {\n \"text\": \"No\",\n \"disqualify\": true\n }\n ]\n }\n ]\n },\n \"panel\": {\n \"target\": 20,\n \"incident_rate\": 25,\n \"country_code\": \"US\",\n \"frequency\": \"one-time\",\n \"dry_run\": 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/create-and-launch-panel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"study\": {\n \"name\": \"Startup CEO AI tool shortlist\",\n \"study_type\": \"in-depth-interview\",\n \"recruiting_method\": \"panel\",\n \"interview_format\": \"voice\",\n \"voice\": \"male\",\n \"language\": \"en\",\n \"expected_duration_seconds\": 1200,\n \"study_plan\": {\n \"objectives\": \"Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.\",\n \"conversation_flow\": \"Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.\",\n \"background\": \"Research into the earliest evaluation stage for AI research tools.\"\n },\n \"targeting_attributes\": [\n {\n \"qualification_id\": 89,\n \"allowed_options\": [\n 1\n ],\n \"disallowed_options\": []\n }\n ],\n \"screener_questions\": [\n {\n \"text\": \"Are you the founder or CEO of a startup?\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"text\": \"Yes\",\n \"disqualify\": false\n },\n {\n \"text\": \"No\",\n \"disqualify\": true\n }\n ]\n }\n ]\n },\n \"panel\": {\n \"target\": 20,\n \"incident_rate\": 25,\n \"country_code\": \"US\",\n \"frequency\": \"one-time\",\n \"dry_run\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.userintuition.ai/api/public/v1/studies/create-and-launch-panel")
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 \"study\": {\n \"name\": \"Startup CEO AI tool shortlist\",\n \"study_type\": \"in-depth-interview\",\n \"recruiting_method\": \"panel\",\n \"interview_format\": \"voice\",\n \"voice\": \"male\",\n \"language\": \"en\",\n \"expected_duration_seconds\": 1200,\n \"study_plan\": {\n \"objectives\": \"Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.\",\n \"conversation_flow\": \"Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.\",\n \"background\": \"Research into the earliest evaluation stage for AI research tools.\"\n },\n \"targeting_attributes\": [\n {\n \"qualification_id\": 89,\n \"allowed_options\": [\n 1\n ],\n \"disallowed_options\": []\n }\n ],\n \"screener_questions\": [\n {\n \"text\": \"Are you the founder or CEO of a startup?\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"text\": \"Yes\",\n \"disqualify\": false\n },\n {\n \"text\": \"No\",\n \"disqualify\": true\n }\n ]\n }\n ]\n },\n \"panel\": {\n \"target\": 20,\n \"incident_rate\": 25,\n \"country_code\": \"US\",\n \"frequency\": \"one-time\",\n \"dry_run\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"panel": {
"study_id": "<string>",
"panel_status": "<string>",
"dry_run": true,
"target": 123,
"country_code": "<string>",
"language_code": "<string>",
"estimated_total_cost_per_interview_usd": 123,
"estimated_total_cost_usd": 123,
"estimated_timeline_hours": 123,
"credit_cost_per_interview": 123,
"total_credit_cost": 123,
"available_credit_balance": 123,
"credit_deficit": 123,
"sufficient_credits": true,
"reward_per_interview_usd": 123,
"card_hold_usd": 123,
"frequency": "one-time",
"assumptions": [
"<string>"
],
"estimate_id": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"study": {
"id": "<string>",
"study_type": "in-depth-interview",
"provisioning_status": "draft",
"fielding_status": "not_started",
"name": "<string>",
"use_case": "<string>",
"recruiting_method": "panel",
"interview_format": "chat",
"voice": "male",
"language": "<string>",
"expected_duration_seconds": 900,
"byop_config": {
"incentive_amount": 123,
"is_incentives_enabled": true,
"auto_send_incentives": true
},
"study_link": "<string>",
"dashboard_url": "<string>",
"missing_requirements": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"interview_count": 123,
"report_status": "available",
"study_plan": {
"objectives": "<string>",
"conversation_flow": "<string>",
"background": "<string>",
"learning_goals": "<string>",
"learning_goals_structured": [
{
"id": "<string>",
"question": "<string>",
"evidence_needed": "<string>"
}
],
"study_specific_rules": "<string>",
"study_improvements": "<string>"
},
"screener_questions": [
{
"id": "<string>",
"text": "<string>",
"type": "single_select",
"order": 123,
"options": [
{
"id": "<string>",
"text": "<string>",
"disqualify": true,
"selection_rule": "must_select"
}
],
"input_mode": "integers_only",
"numeric_ranges": [
{
"min": 1,
"max": 1
}
]
}
],
"targeting_attributes": [
{
"qualification_id": 123,
"allowed_options": [
123
],
"disallowed_options": [
123
]
}
],
"resolved_targeting": [
{
"qualification_id": 123,
"attribute": "<string>",
"active": true,
"include": [
"<string>"
],
"exclude": [
"<string>"
],
"applies_to": "panel",
"approximation_note": "<string>"
}
],
"concept_links": [
{
"id": "<string>",
"url": "<string>",
"label": "<string>",
"embeddable": true
}
],
"concept_images": [
{
"id": "<string>",
"url": "<string>",
"label": "<string>"
}
],
"invitation_count": 123,
"interview_attempt_count": 123,
"quality_interview_count": 123
}
}{
"detail": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "not_started",
"recovery_action": "<string>",
"docs_url": "<string>"
}
}{
"detail": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "not_started",
"recovery_action": "<string>",
"docs_url": "<string>"
}
}Authorizations
Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.
Headers
Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet.
128Body
Preview a Panel study without creating or fielding it. Paid launch requires creating the study, obtaining a current estimate, then calling launch-panel.
Study fields for create-and-launch-panel — no incentive config (always a panel study, so incentives don't apply).
Show child attributes
Show child attributes
Field a paid panel for a Panel-type study. The interview language is taken from the study (not set here).
Show child attributes
Show child attributes
Response
Successful Response
Was this page helpful?
curl --request POST \
--url https://api.userintuition.ai/api/public/v1/studies/create-and-launch-panel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"study": {
"name": "Startup CEO AI tool shortlist",
"study_type": "in-depth-interview",
"recruiting_method": "panel",
"interview_format": "voice",
"voice": "male",
"language": "en",
"expected_duration_seconds": 1200,
"study_plan": {
"objectives": "Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.",
"conversation_flow": "Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.",
"background": "Research into the earliest evaluation stage for AI research tools."
},
"targeting_attributes": [
{
"qualification_id": 89,
"allowed_options": [
1
],
"disallowed_options": []
}
],
"screener_questions": [
{
"text": "Are you the founder or CEO of a startup?",
"type": "single_select",
"options": [
{
"text": "Yes",
"disqualify": false
},
{
"text": "No",
"disqualify": true
}
]
}
]
},
"panel": {
"target": 20,
"incident_rate": 25,
"country_code": "US",
"frequency": "one-time",
"dry_run": true
}
}
'import requests
url = "https://api.userintuition.ai/api/public/v1/studies/create-and-launch-panel"
payload = {
"study": {
"name": "Startup CEO AI tool shortlist",
"study_type": "in-depth-interview",
"recruiting_method": "panel",
"interview_format": "voice",
"voice": "male",
"language": "en",
"expected_duration_seconds": 1200,
"study_plan": {
"objectives": "Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.",
"conversation_flow": "Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.",
"background": "Research into the earliest evaluation stage for AI research tools."
},
"targeting_attributes": [
{
"qualification_id": 89,
"allowed_options": [1],
"disallowed_options": []
}
],
"screener_questions": [
{
"text": "Are you the founder or CEO of a startup?",
"type": "single_select",
"options": [
{
"text": "Yes",
"disqualify": False
},
{
"text": "No",
"disqualify": True
}
]
}
]
},
"panel": {
"target": 20,
"incident_rate": 25,
"country_code": "US",
"frequency": "one-time",
"dry_run": 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({
study: {
name: 'Startup CEO AI tool shortlist',
study_type: 'in-depth-interview',
recruiting_method: 'panel',
interview_format: 'voice',
voice: 'male',
language: 'en',
expected_duration_seconds: 1200,
study_plan: {
objectives: 'Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.',
conversation_flow: 'Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.',
background: 'Research into the earliest evaluation stage for AI research tools.'
},
targeting_attributes: [{qualification_id: 89, allowed_options: [1], disallowed_options: []}],
screener_questions: [
{
text: 'Are you the founder or CEO of a startup?',
type: 'single_select',
options: [{text: 'Yes', disqualify: false}, {text: 'No', disqualify: true}]
}
]
},
panel: {
target: 20,
incident_rate: 25,
country_code: 'US',
frequency: 'one-time',
dry_run: true
}
})
};
fetch('https://api.userintuition.ai/api/public/v1/studies/create-and-launch-panel', 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/create-and-launch-panel",
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([
'study' => [
'name' => 'Startup CEO AI tool shortlist',
'study_type' => 'in-depth-interview',
'recruiting_method' => 'panel',
'interview_format' => 'voice',
'voice' => 'male',
'language' => 'en',
'expected_duration_seconds' => 1200,
'study_plan' => [
'objectives' => 'Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.',
'conversation_flow' => 'Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.',
'background' => 'Research into the earliest evaluation stage for AI research tools.'
],
'targeting_attributes' => [
[
'qualification_id' => 89,
'allowed_options' => [
1
],
'disallowed_options' => [
]
]
],
'screener_questions' => [
[
'text' => 'Are you the founder or CEO of a startup?',
'type' => 'single_select',
'options' => [
[
'text' => 'Yes',
'disqualify' => false
],
[
'text' => 'No',
'disqualify' => true
]
]
]
]
],
'panel' => [
'target' => 20,
'incident_rate' => 25,
'country_code' => 'US',
'frequency' => 'one-time',
'dry_run' => 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/create-and-launch-panel"
payload := strings.NewReader("{\n \"study\": {\n \"name\": \"Startup CEO AI tool shortlist\",\n \"study_type\": \"in-depth-interview\",\n \"recruiting_method\": \"panel\",\n \"interview_format\": \"voice\",\n \"voice\": \"male\",\n \"language\": \"en\",\n \"expected_duration_seconds\": 1200,\n \"study_plan\": {\n \"objectives\": \"Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.\",\n \"conversation_flow\": \"Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.\",\n \"background\": \"Research into the earliest evaluation stage for AI research tools.\"\n },\n \"targeting_attributes\": [\n {\n \"qualification_id\": 89,\n \"allowed_options\": [\n 1\n ],\n \"disallowed_options\": []\n }\n ],\n \"screener_questions\": [\n {\n \"text\": \"Are you the founder or CEO of a startup?\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"text\": \"Yes\",\n \"disqualify\": false\n },\n {\n \"text\": \"No\",\n \"disqualify\": true\n }\n ]\n }\n ]\n },\n \"panel\": {\n \"target\": 20,\n \"incident_rate\": 25,\n \"country_code\": \"US\",\n \"frequency\": \"one-time\",\n \"dry_run\": 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/create-and-launch-panel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"study\": {\n \"name\": \"Startup CEO AI tool shortlist\",\n \"study_type\": \"in-depth-interview\",\n \"recruiting_method\": \"panel\",\n \"interview_format\": \"voice\",\n \"voice\": \"male\",\n \"language\": \"en\",\n \"expected_duration_seconds\": 1200,\n \"study_plan\": {\n \"objectives\": \"Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.\",\n \"conversation_flow\": \"Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.\",\n \"background\": \"Research into the earliest evaluation stage for AI research tools.\"\n },\n \"targeting_attributes\": [\n {\n \"qualification_id\": 89,\n \"allowed_options\": [\n 1\n ],\n \"disallowed_options\": []\n }\n ],\n \"screener_questions\": [\n {\n \"text\": \"Are you the founder or CEO of a startup?\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"text\": \"Yes\",\n \"disqualify\": false\n },\n {\n \"text\": \"No\",\n \"disqualify\": true\n }\n ]\n }\n ]\n },\n \"panel\": {\n \"target\": 20,\n \"incident_rate\": 25,\n \"country_code\": \"US\",\n \"frequency\": \"one-time\",\n \"dry_run\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.userintuition.ai/api/public/v1/studies/create-and-launch-panel")
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 \"study\": {\n \"name\": \"Startup CEO AI tool shortlist\",\n \"study_type\": \"in-depth-interview\",\n \"recruiting_method\": \"panel\",\n \"interview_format\": \"voice\",\n \"voice\": \"male\",\n \"language\": \"en\",\n \"expected_duration_seconds\": 1200,\n \"study_plan\": {\n \"objectives\": \"Understand what triggers startup CEOs to evaluate AI-powered research tools, how they build a shortlist, and what proof makes a provider credible.\",\n \"conversation_flow\": \"Discuss the last important customer-research decision, how the CEO gathered input, why they considered an AI tool, alternatives they compared, trust thresholds, and evidence needed to shortlist one.\",\n \"background\": \"Research into the earliest evaluation stage for AI research tools.\"\n },\n \"targeting_attributes\": [\n {\n \"qualification_id\": 89,\n \"allowed_options\": [\n 1\n ],\n \"disallowed_options\": []\n }\n ],\n \"screener_questions\": [\n {\n \"text\": \"Are you the founder or CEO of a startup?\",\n \"type\": \"single_select\",\n \"options\": [\n {\n \"text\": \"Yes\",\n \"disqualify\": false\n },\n {\n \"text\": \"No\",\n \"disqualify\": true\n }\n ]\n }\n ]\n },\n \"panel\": {\n \"target\": 20,\n \"incident_rate\": 25,\n \"country_code\": \"US\",\n \"frequency\": \"one-time\",\n \"dry_run\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"panel": {
"study_id": "<string>",
"panel_status": "<string>",
"dry_run": true,
"target": 123,
"country_code": "<string>",
"language_code": "<string>",
"estimated_total_cost_per_interview_usd": 123,
"estimated_total_cost_usd": 123,
"estimated_timeline_hours": 123,
"credit_cost_per_interview": 123,
"total_credit_cost": 123,
"available_credit_balance": 123,
"credit_deficit": 123,
"sufficient_credits": true,
"reward_per_interview_usd": 123,
"card_hold_usd": 123,
"frequency": "one-time",
"assumptions": [
"<string>"
],
"estimate_id": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"study": {
"id": "<string>",
"study_type": "in-depth-interview",
"provisioning_status": "draft",
"fielding_status": "not_started",
"name": "<string>",
"use_case": "<string>",
"recruiting_method": "panel",
"interview_format": "chat",
"voice": "male",
"language": "<string>",
"expected_duration_seconds": 900,
"byop_config": {
"incentive_amount": 123,
"is_incentives_enabled": true,
"auto_send_incentives": true
},
"study_link": "<string>",
"dashboard_url": "<string>",
"missing_requirements": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"interview_count": 123,
"report_status": "available",
"study_plan": {
"objectives": "<string>",
"conversation_flow": "<string>",
"background": "<string>",
"learning_goals": "<string>",
"learning_goals_structured": [
{
"id": "<string>",
"question": "<string>",
"evidence_needed": "<string>"
}
],
"study_specific_rules": "<string>",
"study_improvements": "<string>"
},
"screener_questions": [
{
"id": "<string>",
"text": "<string>",
"type": "single_select",
"order": 123,
"options": [
{
"id": "<string>",
"text": "<string>",
"disqualify": true,
"selection_rule": "must_select"
}
],
"input_mode": "integers_only",
"numeric_ranges": [
{
"min": 1,
"max": 1
}
]
}
],
"targeting_attributes": [
{
"qualification_id": 123,
"allowed_options": [
123
],
"disallowed_options": [
123
]
}
],
"resolved_targeting": [
{
"qualification_id": 123,
"attribute": "<string>",
"active": true,
"include": [
"<string>"
],
"exclude": [
"<string>"
],
"applies_to": "panel",
"approximation_note": "<string>"
}
],
"concept_links": [
{
"id": "<string>",
"url": "<string>",
"label": "<string>",
"embeddable": true
}
],
"concept_images": [
{
"id": "<string>",
"url": "<string>",
"label": "<string>"
}
],
"invitation_count": 123,
"interview_attempt_count": 123,
"quality_interview_count": 123
}
}{
"detail": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "not_started",
"recovery_action": "<string>",
"docs_url": "<string>"
}
}{
"detail": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "not_started",
"recovery_action": "<string>",
"docs_url": "<string>"
}
}
