Skip to main content
POST
/
api
/
repdata
/
create_study_survey
Create Panel
curl --request POST \
  --url https://api.userintuition.ai/api/repdata/create_study_survey \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": "assistant-id-123",
  "target": 50,
  "country_code": "US",
  "language_code": "EN"
}
'
{ "invite_id": "invite-id-789", "assistant_id": "assistant-id-123", "panel_status": "launching" }

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
assistant_id
string
required

The Panel study (assistant) to recruit for. Must have is_panel=true.

​
target
integer
required

Target number of completed responses.

​
country_code
string
default:US

ISO country code (e.g. US, GB, FR).

​
language_code
string
default:EN

ISO language code (e.g. EN, ES).

​
frequency
string | null

Recurring schedule: weekly | monthly | quarterly. Omit for a one-time target.

​
dry_run
boolean
default:false

If true, return a cost estimate (credits + card reward-hold) without provisioning, holding, or charging.

Response

Panel launching — or, when dry_run=true, a cost estimate with no side effects

​
invite_id
string

The panel invite created for this launch.

​
assistant_id
string
​
panel_status
string

Panel status, e.g. launching.