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

# Get Study Embed Code

> Return copy-ready HTML that launches a study from another website.



## OpenAPI

````yaml /api-reference/openapi.json get /api/public/v1/studies/{study_id}/embed-code
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}/embed-code:
    get:
      tags:
        - public-studies
      summary: Get Study Embed Code
      description: Return copy-ready HTML that launches a study from another website.
      operationId: getStudyEmbedCode
      parameters:
        - name: study_id
          in: path
          required: true
          schema:
            type: string
            title: Study Id
        - name: type
          in: query
          required: false
          schema:
            enum:
              - widget
              - button
            type: string
            description: Return a full interview widget or a link styled as a button
            default: widget
            title: Type
          description: Return a full interview widget or a link styled as a button
        - name: X-UI-Organization-ID
          in: header
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 128
              - type: 'null'
            description: >-
              Choose an organization you belong to for scoped reads, writes, and
              billing. Users can belong to multiple organizations. Platform
              administrators may select any organization in this app.
            title: X-Ui-Organization-Id
          description: >-
            Choose an organization you belong to for scoped reads, writes, and
            billing. Users can belong to multiple organizations. Platform
            administrators may select any organization in this app.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicStudyEmbedCode'
        '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:
    PublicStudyEmbedCode:
      properties:
        type:
          type: string
          enum:
            - widget
            - button
          title: Type
        code:
          type: string
          title: Code
          description: Copy-ready HTML embed code
        study_link:
          type: string
          title: Study Link
          description: Universal interview link used by the embed
      type: object
      required:
        - type
        - code
        - study_link
      title: PublicStudyEmbedCode
      description: Copy-ready HTML for embedding a study on another website.
    PublicApiErrorResponse:
      type: object
      required:
        - detail
        - error
      properties:
        detail:
          description: Legacy error detail; may be a string, list, or object.
        error:
          $ref: '#/components/schemas/PublicApiError'
    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
  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.