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
}
'
import requests

url = "https://api.userintuition.ai/api/public/v1/studies/{study_id}/launch-panel"

payload = {
    "target": 123,
    "country_code": "US",
    "frequency": "one-time",
    "dry_run": False
}
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({target: 123, country_code: 'US', frequency: 'one-time', dry_run: false})
};

fetch('https://api.userintuition.ai/api/public/v1/studies/{study_id}/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/{study_id}/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([
    'target' => 123,
    'country_code' => 'US',
    'frequency' => 'one-time',
    'dry_run' => false
  ]),
  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/{study_id}/launch-panel"

	payload := strings.NewReader("{\n  \"target\": 123,\n  \"country_code\": \"US\",\n  \"frequency\": \"one-time\",\n  \"dry_run\": false\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/{study_id}/launch-panel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target\": 123,\n  \"country_code\": \"US\",\n  \"frequency\": \"one-time\",\n  \"dry_run\": false\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.userintuition.ai/api/public/v1/studies/{study_id}/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  \"target\": 123,\n  \"country_code\": \"US\",\n  \"frequency\": \"one-time\",\n  \"dry_run\": false\n}"

response = http.request(request)
puts response.read_body
{
  "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
}
{
  "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.

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).