Skip to main content
POST
Create Study And Launch Panel

Authorizations

Authorization
string
header
required

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

Headers

X-UI-Organization-ID
string | null

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

Body

application/json

Preview a Panel study without creating or fielding it. Paid launch requires creating the study, obtaining a current estimate, then calling launch-panel.

study
PublicPanelStudyCreate · object
required

Study fields for create-and-launch-panel — no incentive config (always a panel study, so incentives don't apply).

panel
PublicPanelCreate · object
required

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

Response

Successful Response

panel
PublicPanelResponse · object
required

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

study
PublicStudy · object | null

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