Skip to main content
POST
/
api
/
public
/
v1
/
studies
/
create-and-launch
Create And Launch Study
curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/studies/create-and-launch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "study": {
    "name": "<string>",
    "study_type": "<string>",
    "study_plan": {
      "objectives": "<string>",
      "conversation_flow": "<string>",
      "background": "<string>",
      "learning_goals": "<string>",
      "key_questions": "<string>",
      "study_specific_rules": "<string>"
    },
    "screener_questions": [
      {
        "text": "<string>",
        "type": "single_select",
        "options": [
          {
            "text": "<string>",
            "disqualify": false,
            "id": "<string>"
          }
        ],
        "order": 123,
        "id": "<string>",
        "text_values": [
          "<string>"
        ],
        "disallowed_text_values": [
          "<string>"
        ],
        "category": "<string>"
      }
    ],
    "byop_config": {
      "incentive_amount": 203,
      "is_incentives_enabled": true,
      "auto_send_incentives": true
    },
    "concept_link": [
      {
        "label": "Pricing Page A",
        "url": "https://example.com/pricing-a"
      },
      {
        "label": "Pricing Page B",
        "url": "https://example.com/pricing-b"
      }
    ]
  },
  "panel": {
    "target": 123,
    "country_code": "US",
    "frequency": "<string>",
    "dry_run": false
  }
}
'
{
  "panel": {
    "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
    ]
  },
  "study": {
    "id": "<string>",
    "name": "<string>",
    "study_type": "<string>",
    "recruiting_method": "<string>",
    "language": "<string>",
    "byop_config": {
      "incentive_amount": 123,
      "is_incentives_enabled": true,
      "auto_send_incentives": true
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "study_plan": {
      "objectives": "<string>",
      "conversation_flow": "<string>",
      "background": "<string>",
      "learning_goals": "<string>",
      "key_questions": "<string>",
      "study_specific_rules": "<string>"
    },
    "screener_questions": [
      {
        "id": "<string>",
        "text": "<string>",
        "type": "<string>",
        "order": 123,
        "options": [
          {
            "id": "<string>",
            "text": "<string>",
            "disqualify": true
          }
        ],
        "text_values": [
          "<string>"
        ],
        "disallowed_text_values": [
          "<string>"
        ],
        "category": "<string>"
      }
    ],
    "concept_link": null,
    "total_invites": 123,
    "total_calls": 123,
    "excellent_calls": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Create a study and immediately field a panel for it. The study is always created as a Panel study (recruiting_method is forced to panel). Set panel.dry_run to get a cost estimate without creating or fielding anything.

​
study
PublicStudyCreate · object
required

Create a study. Only user-facing fields are accepted; unknown fields are rejected.

​
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

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