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

> Start a durable analysis of the session sources. Reuse Idempotency-Key after a timeout. Study findings are prepared on sync and reused; editorial revisions reuse the original evidence. Presentation outputs automatically queue a PowerPoint when analysis completes.



## OpenAPI

````yaml /api-reference/openapi.json post /api/public/v1/intelligence-hub/sessions/{session_id}/runs
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/intelligence-hub/sessions/{session_id}/runs:
    post:
      tags:
        - public-intelligence-hub
      summary: Create Run
      description: >-
        Start a durable analysis of the session sources. Reuse Idempotency-Key
        after a timeout. Study findings are prepared on sync and reused;
        editorial revisions reuse the original evidence. Presentation outputs
        automatically queue a PowerPoint when analysis completes.
      operationId: publicHub_create_run
      parameters:
        - name: session_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Session Id
        - name: idempotency-key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 200
            title: Idempotency-Key
        - 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.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunRequest'
            examples:
              Evidence-backed presentation:
                summary: Analyze all eligible interviews
                description: >-
                  Use a selected session and Idempotency-Key. Exhaustive work
                  pauses rather than silently dropping sources when the budget
                  is exhausted.
                value:
                  question: What pricing and setup problems did participants describe?
                  mode: exhaustive
                  output_type: presentation
                  output_name: Pricing and setup findings
                  call_budget: 100
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '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:
    RunRequest:
      properties:
        question:
          type: string
          minLength: 1
          title: Question
        mode:
          type: string
          enum:
            - quick
            - exhaustive
            - explore
            - aggregate
          title: Mode
          default: quick
        output_type:
          type: string
          enum:
            - answer
            - report
            - table
            - presentation
          title: Output Type
          default: answer
        output_name:
          anyOf:
            - type: string
              maxLength: 200
            - type: 'null'
          title: Output Name
        template_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Template Id
          description: >-
            Session-owned report or PowerPoint template uploaded before
            generation
        call_budget:
          anyOf:
            - type: integer
            - type: 'null'
          title: Call Budget
          description: Deprecated; analysis continues until its scoped work completes.
          deprecated: true
        include_synthetic:
          type: boolean
          title: Include Synthetic
          default: false
        parent_run_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Parent Run Id
        revision_output_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Revision Output Id
        group_by:
          anyOf:
            - type: string
              maxLength: 200
            - type: 'null'
          title: Group By
        codebook:
          items:
            type: string
          type: array
          title: Codebook
      type: object
      required:
        - question
      title: RunRequest
    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.