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

# Generate Report

> Analyze the study's interview transcripts and return the report.



## OpenAPI

````yaml /api-reference/openapi.json post /api/public/v1/studies/{study_id}/report
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}/report:
    post:
      tags:
        - public-studies
      summary: Generate Report
      description: Analyze the study's interview transcripts and return the report.
      operationId: generateStudyReport
      parameters:
        - name: study_id
          in: path
          required: true
          schema:
            type: string
            title: Study Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicReport'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PublicReport:
      properties:
        study_id:
          type: string
          title: Study Id
          description: The study this report was generated for
        report:
          anyOf:
            - type: string
            - type: 'null'
          title: Report
          description: Rendered report (the references section is moved to `references`)
        references:
          items:
            $ref: '#/components/schemas/PublicReportReference'
          type: array
          title: References
        interview_count:
          type: integer
          title: Interview Count
          description: Number of interviews included in the report
          default: 0
        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
      type: object
      required:
        - study_id
      title: PublicReport
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublicReportReference:
      properties:
        reference_id:
          type: string
          title: Reference Id
          description: Citation id used in the report text
        interview_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Interview Id
          description: The interview this reference quotes
        audio_recording_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Audio Recording Url
        video_recording_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Video Recording Url
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
          description: When the interview started
        duration_seconds:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration Seconds
          description: Interview length in seconds
        message_text:
          anyOf:
            - type: string
            - type: 'null'
          title: Message Text
          description: The quoted message text
      type: object
      required:
        - reference_id
      title: PublicReportReference
      description: A citation in the report, resolved to the interview + message it quotes.
    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.

````