Skip to main content
POST
/
api
/
public
/
v1
/
studies
/
{study_id}
/
launch-panel
Launch Panel
curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/studies/{study_id}/launch-panel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": 123,
  "country_code": "US",
  "frequency": "one-time",
  "dry_run": false
}
'
{
  "study_id": "<string>",
  "panel_status": "<string>",
  "dry_run": true,
  "target": 123,
  "estimated_total_cost_per_interview_usd": 123,
  "estimated_total_cost_usd": 123,
  "estimated_timeline_hours": 123
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
study_id
string
required

Body

application/json

Field a paid panel for a Panel-type study. The interview language is taken from the study (not set here).

​
target
integer
required

Target number of completed responses

​
country_code
enum<string>
default:US

Target country (one of the supported countries).

Available options:
AR,
AU,
AT,
BE,
BO,
BR,
CA,
CL,
CN,
CO,
CR,
CZ,
DK,
DO,
EG,
FI,
FR,
DE,
GR,
HK,
HU,
IN,
ID,
IE,
IT,
JP,
KE,
KR,
LU,
MY,
MX,
NL,
NZ,
NG,
NO,
PK,
PE,
PH,
PL,
PT,
RO,
RU,
SA,
SG,
SK,
ZA,
ES,
SE,
CH,
TW,
TH,
TR,
UG,
AE,
GB,
US,
VN
​
frequency
enum<string>
default:one-time

Recurring schedule, or one-time.

Available options:
one-time,
weekly,
monthly,
quarterly
​
dry_run
boolean
default:false

Return a cost estimate without provisioning the panel

Response

Successful Response

Either a launch acknowledgement (study_id + panel_status) or, for dry_run, a cost + timeline estimate.

​
study_id
string | null
​
panel_status
string | null
​
dry_run
boolean | null
​
target
integer | null
​
estimated_total_cost_per_interview_usd
number | null

Per-interview cost in USD (interview credit cost + participant reward).

​
estimated_total_cost_usd
number | null

Total estimated cost in USD (per-interview × target).

​
estimated_timeline_hours
integer | null

Estimated time to complete, in whole hours (rounded up).