> ## Documentation Index
> Fetch the complete documentation index at: https://docs.userintuition.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Study And Launch Panel

> Create a study and immediately launch a panel for it, in one call. The study
is created as a Panel study and the panel uses the study's interview language.
Set ``panel.dry_run`` to get a cost estimate without creating or fielding anything.



## OpenAPI

````yaml /api-reference/openapi.json post /api/public/v1/studies/create-and-launch-panel
openapi: 3.1.0
info:
  title: User Intuition Public API
  description: >-
    ## Public Integration API


    Programmatic access to User Intuition for external integrators: manage
    studies, participants, interviews, reports, and panels.


    ### Authentication


    All endpoints require a Bearer token — either an API key (prefixed `ui_sk_`,
    created in the dashboard) or a dashboard JWT:


    ```

    Authorization: Bearer <ui_sk_… or JWT>

    ```


    ### Base URLs


    - **Production:** `https://api.userintuition.ai`

    - **Staging:** `https://staging.userintuition.ai`


    ### Support


    For API support, contact support@userintuition.ai
  version: 1.0.0
  contact:
    name: User Intuition Support
    email: support@userintuition.ai
servers:
  - url: https://api.userintuition.ai
    description: Production
  - url: https://staging.userintuition.ai
    description: Staging
security:
  - BearerAuth: []
paths:
  /api/public/v1/studies/create-and-launch-panel:
    post:
      tags:
        - public-studies
      summary: Create Study And Launch Panel
      description: >-
        Create a study and immediately launch a panel for it, in one call. The
        study

        is created as a Panel study and the panel uses the study's interview
        language.

        Set ``panel.dry_run`` to get a cost estimate without creating or
        fielding anything.
      operationId: createStudyAndLaunchPanel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCreateAndLaunch'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicCreateAndLaunchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PublicCreateAndLaunch:
      properties:
        study:
          $ref: '#/components/schemas/PublicPanelStudyCreate'
        panel:
          $ref: '#/components/schemas/PublicPanelCreate'
      additionalProperties: false
      type: object
      required:
        - study
        - panel
      title: PublicCreateAndLaunch
      description: >-
        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``;
        incentives

        don't apply). Set ``panel.dry_run`` to get a cost estimate without
        creating or

        fielding anything.
    PublicCreateAndLaunchResponse:
      properties:
        study:
          anyOf:
            - $ref: '#/components/schemas/PublicStudy'
            - type: 'null'
        panel:
          $ref: '#/components/schemas/PublicPanelResponse'
      type: object
      required:
        - panel
      title: PublicCreateAndLaunchResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicPanelStudyCreate:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Study display name
        study_type:
          type: string
          const: in-depth-interview
          title: Study Type
          description: Study-type template slug
          default: in-depth-interview
        recruiting_method:
          anyOf:
            - type: string
              enum:
                - panel
                - byop
            - type: 'null'
          title: Recruiting Method
          description: panel (recruit from the panel) or byop (bring your own participants)
        interview_format:
          anyOf:
            - type: string
              enum:
                - chat
                - video
                - voice
            - type: 'null'
          title: Interview Format
          description: chat, video, or voice
        voice:
          anyOf:
            - type: string
              enum:
                - male
                - female
            - type: 'null'
          title: Voice
          description: 'Interviewer voice: male (Elliot) or female (Clara)'
        language:
          anyOf:
            - type: string
            - type: 'null'
          enum:
            - auto
            - ar
            - bg
            - cs
            - da
            - de
            - el
            - en
            - es
            - fi
            - fil
            - fr
            - hi
            - hr
            - id
            - it
            - ja
            - ko
            - ms
            - nl
            - pl
            - pt
            - ro
            - ru
            - sk
            - sv
            - ta
            - tr
            - uk
            - zh
          title: Language
          description: >-
            Interview language: an ISO 639-1 code, or 'auto' to auto-detect.
            Must be one of the supported options.
        study_plan:
          anyOf:
            - $ref: '#/components/schemas/PublicStudyPlan'
            - type: 'null'
          description: Interview instructions as named sections.
        screener_questions:
          anyOf:
            - items:
                $ref: '#/components/schemas/PublicScreenerQuestionInput'
              type: array
            - type: 'null'
          title: Screener Questions
        targeting_attributes:
          anyOf:
            - items:
                $ref: '#/components/schemas/PublicTargetingAttribute'
              type: array
            - type: 'null'
          title: Targeting Attributes
          description: Target the panel by demographic qualifications (panel studies).
      additionalProperties: false
      type: object
      title: PublicPanelStudyCreate
      description: |-
        Study fields for create-and-launch-panel — no incentive config (always a
        panel study, so incentives don't apply).
    PublicPanelCreate:
      properties:
        target:
          type: integer
          title: Target
          description: Target number of completed responses
        country_code:
          type: string
          enum:
            - 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
          title: Country Code
          description: Target country (one of the supported countries).
          default: US
        frequency:
          type: string
          enum:
            - one-time
            - weekly
            - monthly
            - quarterly
          title: Frequency
          description: Recurring schedule, or one-time.
          default: one-time
        dry_run:
          type: boolean
          title: Dry Run
          description: Return a cost estimate without provisioning the panel
          default: false
      additionalProperties: false
      type: object
      required:
        - target
      title: PublicPanelCreate
      description: >-
        Field a paid panel for a Panel-type study. The interview language is
        taken

        from the study (not set here).
    PublicStudy:
      properties:
        id:
          type: string
          title: Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        study_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Type
          description: Study-type template slug
        recruiting_method:
          anyOf:
            - type: string
            - type: 'null'
          title: Recruiting Method
          description: panel or byop
        interview_format:
          anyOf:
            - type: string
              enum:
                - chat
                - video
                - voice
            - type: 'null'
          title: Interview Format
          description: chat, video, or voice
        voice:
          anyOf:
            - type: string
              enum:
                - male
                - female
            - type: 'null'
          title: Voice
          description: male or female
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
          description: Interview language code, e.g. 'en'
        byop_config:
          $ref: '#/components/schemas/PublicByopConfigOut'
        study_link:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Link
          description: Universal interview link for the study
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
        study_plan:
          anyOf:
            - $ref: '#/components/schemas/PublicStudyPlanOut'
            - type: 'null'
        screener_questions:
          anyOf:
            - items:
                $ref: '#/components/schemas/PublicScreenerQuestion'
              type: array
            - type: 'null'
          title: Screener Questions
        targeting_attributes:
          anyOf:
            - items:
                $ref: '#/components/schemas/PublicTargetingAttribute'
              type: array
            - type: 'null'
          title: Targeting Attributes
        total_invites:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Invites
        total_calls:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Calls
        quality_calls:
          anyOf:
            - type: integer
            - type: 'null'
          title: Quality Calls
          description: Number of quality interviews
      type: object
      required:
        - id
      title: PublicStudy
      description: Full study shape returned by get-by-id (includes the heavy fields).
    PublicPanelResponse:
      properties:
        study_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Id
        panel_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Panel Status
        dry_run:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Dry Run
        target:
          anyOf:
            - type: integer
            - type: 'null'
          title: Target
        estimated_total_cost_per_interview_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Estimated Total Cost Per Interview Usd
          description: >-
            Per-interview cost in USD (interview credit cost + participant
            reward).
        estimated_total_cost_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Estimated Total Cost Usd
          description: Total estimated cost in USD (per-interview × target).
        estimated_timeline_hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Estimated Timeline Hours
          description: Estimated time to complete, in whole hours (rounded up).
      type: object
      title: PublicPanelResponse
      description: |-
        Either a launch acknowledgement (study_id + panel_status) or, for
        ``dry_run``, a cost + timeline estimate.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PublicStudyPlan:
      properties:
        objectives:
          type: string
          title: Objectives
          description: What the study is trying to learn and the decision it informs.
        conversation_flow:
          type: string
          title: Conversation Flow
          description: >-
            How the interview should flow — topics/clusters with example
            prompts.
        background:
          anyOf:
            - type: string
            - type: 'null'
          title: Background
          description: Context about the company/product/market.
        learning_goals:
          anyOf:
            - type: string
            - type: 'null'
          title: Learning Goals
          description: The critical things to learn (bullets).
        key_questions:
          anyOf:
            - type: string
            - type: 'null'
          title: Key Questions
          description: The specific questions to answer (bullets).
        study_specific_rules:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Specific Rules
          description: Operational guardrails and neutrality notes.
      additionalProperties: false
      type: object
      required:
        - objectives
        - conversation_flow
      title: PublicStudyPlan
      description: |-
        The interview instructions, as named sections. ``objectives`` and
        ``conversation_flow`` are required; the rest are optional. Each value is
        free-form text/markdown (bullets allowed).
    PublicScreenerQuestionInput:
      properties:
        text:
          type: string
          title: Text
        type:
          type: string
          title: Type
          description: single_select, multi_select, or text_input
          default: single_select
        options:
          items:
            $ref: '#/components/schemas/PublicScreenerOptionInput'
          type: array
          title: Options
        order:
          anyOf:
            - type: integer
            - type: 'null'
          title: Order
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
        text_values:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Text Values
        disallowed_text_values:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Disallowed Text Values
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
      additionalProperties: false
      type: object
      required:
        - text
      title: PublicScreenerQuestionInput
      description: >-
        Inbound screener question. ``id``/``order`` are auto-generated if
        omitted.
    PublicTargetingAttribute:
      properties:
        qualification_id:
          type: integer
          title: Qualification Id
          description: Qualification id (from GET /targeting-attributes)
        allowed_options:
          items:
            type: integer
          type: array
          title: Allowed Options
          description: option_ids to allow
        disallowed_options:
          items:
            type: integer
          type: array
          title: Disallowed Options
          description: option_ids to disqualify
      additionalProperties: false
      type: object
      required:
        - qualification_id
      title: PublicTargetingAttribute
      description: >-
        Target the panel by a qualification's answer options. Option-id rules:

        - both lists empty → allow all options;

        - only allowed → disqualify any option not listed;

        - only disallowed → allow any option not listed (can't disallow them
        all);

        - both → allowed are kept, disallowed are disqualified, and together
        they
          must cover every option_id of the qualification.
        Look up qualification_id / option_id via GET /targeting-attributes.
    PublicByopConfigOut:
      properties:
        incentive_amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Incentive Amount
        is_incentives_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Incentives Enabled
        auto_send_incentives:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Auto Send Incentives
      type: object
      title: PublicByopConfigOut
    PublicStudyPlanOut:
      properties:
        objectives:
          anyOf:
            - type: string
            - type: 'null'
          title: Objectives
        conversation_flow:
          anyOf:
            - type: string
            - type: 'null'
          title: Conversation Flow
        background:
          anyOf:
            - type: string
            - type: 'null'
          title: Background
        learning_goals:
          anyOf:
            - type: string
            - type: 'null'
          title: Learning Goals
        key_questions:
          anyOf:
            - type: string
            - type: 'null'
          title: Key Questions
        study_specific_rules:
          anyOf:
            - type: string
            - type: 'null'
          title: Study Specific Rules
      type: object
      title: PublicStudyPlanOut
      description: >-
        Response variant — all sections optional (a study's stored prompt may
        not

        contain every section).
    PublicScreenerQuestion:
      properties:
        id:
          type: string
          title: Id
        text:
          type: string
          title: Text
        type:
          type: string
          title: Type
          description: single_select, multi_select, or text_input
        order:
          type: integer
          title: Order
        options:
          items:
            $ref: '#/components/schemas/PublicScreenerOption'
          type: array
          title: Options
        text_values:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Text Values
        disallowed_text_values:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Disallowed Text Values
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
      type: object
      required:
        - id
        - text
        - type
        - order
      title: PublicScreenerQuestion
    PublicScreenerOptionInput:
      properties:
        text:
          type: string
          title: Text
        disqualify:
          type: boolean
          title: Disqualify
          default: false
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
      additionalProperties: false
      type: object
      required:
        - text
      title: PublicScreenerOptionInput
      description: Inbound screener option. ``id`` is auto-generated if omitted.
    PublicScreenerOption:
      properties:
        id:
          type: string
          title: Id
        text:
          type: string
          title: Text
        disqualify:
          type: boolean
          title: Disqualify
      type: object
      required:
        - id
        - text
        - disqualify
      title: PublicScreenerOption
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````