> ## 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 ``` ### 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 example: 11111111-2222-3333-4444-555555555555 - name: Idempotency-Key in: header required: false schema: anyOf: - type: string - type: 'null' title: Idempotency-Key - name: X-UI-Organization-ID in: header required: false schema: anyOf: - type: string maxLength: 128 - type: 'null' description: >- Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet. title: X-Ui-Organization-Id description: >- Platform admins only: choose an organization for scoped reads and writes. Required to change another organization's study or use its wallet. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PublicPanelCreate' examples: Cost estimate: summary: Untargeted cost estimate description: >- Returns estimated price and timeline without starting recruitment. value: target: 20 incident_rate: 25 country_code: US frequency: one-time dry_run: true Fixed option targets: summary: Estimate with fixed option targets description: >- Reserves 8 interviews for option 1. Other qualifying options share the remaining 12 interviews. value: target: 20 incident_rate: 25 country_code: US frequency: one-time dry_run: true targeting_attributes: - qualification_id: 2 option_targets: - option_id: 1 target: 8 Option-target object map: summary: Option targets as an object map description: >- Direct API clients may key option_targets by option ID. This is equivalent to the array form. value: target: 20 incident_rate: 25 country_code: US frequency: one-time dry_run: true targeting_attributes: - qualification_id: 2 option_targets: '1': 8 Paid launch: summary: Start paid recruitment description: >- Launch an already-provisioned Panel study with a current estimate_id from estimatePanel after approval. value: target: 20 incident_rate: 25 country_code: US frequency: one-time dry_run: false estimate_id: >- est_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PublicPanelResponse' '422': description: Public API error. X-Request-ID matches error.request_id. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' default: description: Public API error. X-Request-ID matches error.request_id. content: application/json: schema: $ref: '#/components/schemas/PublicApiErrorResponse' components: schemas: PublicPanelCreate: properties: target: type: integer maximum: 1000 exclusiveMinimum: 0 title: Target description: >- Target number of completed responses (maximum 1,000 for direct launch; request feasibility for larger studies) incident_rate: type: number maximum: 100 minimum: 0 title: Incident Rate description: >- Expected audience incidence rate as percentage points (10 means 10%). Rates below 10% require a feasibility request. country_code: type: string enum: - AR - AU - AT - BE - BO - BR - CA - CL - CN - CO - CR - CZ - DK - DO - EC - 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). Required for every public Panel estimate and launch; no country is inferred. frequency: type: string enum: - one-time - weekly - monthly - quarterly title: Frequency description: Recurring schedule, or one-time. default: one-time targeting_attributes: items: $ref: '#/components/schemas/PublicPanelTargetingAttribute' type: array title: Targeting Attributes description: >- Optional launch-specific targets for single-select panel attributes. Each target must be a positive whole number; per-attribute totals may not exceed target; and an under-filled attribute must leave an option open. dry_run: type: boolean title: Dry Run description: Return a cost estimate without provisioning the panel default: false estimate_id: anyOf: - type: string - type: 'null' title: Estimate Id description: >- Short-lived estimate identifier required for a paid launch; obtain it from estimatePanel additionalProperties: false type: object required: - target - incident_rate - country_code 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 country_code: anyOf: - type: string - type: 'null' title: Country Code description: Resolved ISO country code used for the estimate or launch. language_code: anyOf: - type: string - type: 'null' title: Language Code description: >- Resolved lowercase panel language code used for the estimate or launch. 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: >- Heuristic time to complete, in whole hours (rounded up); audience and country may change actual timing. credit_cost_per_interview: anyOf: - type: number - type: 'null' title: Credit Cost Per Interview total_credit_cost: anyOf: - type: number - type: 'null' title: Total Credit Cost available_credit_balance: anyOf: - type: number - type: 'null' title: Available Credit Balance credit_deficit: anyOf: - type: number - type: 'null' title: Credit Deficit sufficient_credits: anyOf: - type: boolean - type: 'null' title: Sufficient Credits reward_per_interview_usd: anyOf: - type: number - type: 'null' title: Reward Per Interview Usd card_hold_usd: anyOf: - type: number - type: 'null' title: Card Hold Usd frequency: anyOf: - type: string enum: - one-time - weekly - monthly - quarterly - type: 'null' title: Frequency description: >- Estimate applies to one cycle of this recurrence; later cycles may be repriced. assumptions: items: type: string type: array title: Assumptions estimate_id: anyOf: - type: string - type: 'null' title: Estimate Id description: >- Fingerprint of the study version, launch inputs, and current estimated price expires_at: anyOf: - type: string format: date-time - type: 'null' title: Expires At description: Estimate expiry; request a new estimate after this time type: object title: PublicPanelResponse description: |- Either a launch acknowledgement (study_id + panel_status) or, for ``dry_run``, a cost + timeline estimate. PublicApiErrorResponse: type: object required: - detail - error properties: detail: description: Legacy error detail; may be a string, list, or object. error: $ref: '#/components/schemas/PublicApiError' PublicPanelTargetingAttribute: properties: qualification_id: type: integer title: Qualification Id description: Qualification id from GET /targeting-attributes option_targets: anyOf: - items: $ref: '#/components/schemas/PublicPanelOptionTarget' type: array - additionalProperties: type: integer type: object title: Option Targets description: >- Fixed interview targets. The playground uses [{option_id, target}]; direct API callers may also send an object keyed by option_id. Omitted options remain open. additionalProperties: false type: object required: - qualification_id title: PublicPanelTargetingAttribute description: >- Launch-specific targets for qualifying options of one panel attribute. ``qualification_id`` and the keys in ``option_targets`` come from the targeting-attributes catalog. Options omitted from ``option_targets`` stay open and share the remaining panel capacity. PublicApiError: type: object required: - code - message - field - request_id - outcome - recovery_action - docs_url properties: code: type: string message: type: string field: anyOf: - type: string - type: 'null' request_id: type: string format: uuid outcome: type: string enum: - not_started - failed - unknown recovery_action: type: string docs_url: type: string format: uri PublicPanelOptionTarget: properties: option_id: type: integer title: Option Id description: Option id from GET /targeting-attributes target: type: integer title: Target description: Fixed number of completed interviews for this option additionalProperties: false type: object required: - option_id - target title: PublicPanelOptionTarget description: Playground-safe representation of one fixed option target. securitySchemes: BearerAuth: type: http scheme: bearer description: >- Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.