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

# Launch Panel

> Launch a paid panel for a Panel-type study (use ``dry_run`` for a cost estimate).



## OpenAPI

````yaml /api-reference/openapi.json post /api/public/v1/studies/{study_id}/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/{study_id}/launch-panel:
    post:
      tags:
        - public-studies
      summary: Launch Panel
      description: >-
        Launch a paid panel for a Panel-type study (use ``dry_run`` for a cost
        estimate).
      operationId: launchPanel
      parameters:
        - name: study_id
          in: path
          required: true
          schema:
            type: string
            title: Study Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicPanelCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPanelResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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).
    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.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````