> ## 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 Observer Session

> Create a short-lived, revocable observer link for one live interview. Choose observation, steering, and end-call capabilities explicitly; share the returned bearer link only with authorized observers.



## OpenAPI

````yaml /api-reference/openapi.json post /api/public/v1/studies/{study_id}/live-interviews/{call_id}/observer-sessions
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}/live-interviews/{call_id}/observer-sessions:
    post:
      tags:
        - public-observers
      summary: Create Observer Session
      description: >-
        Create a short-lived, revocable observer link for one live interview.
        Choose observation, steering, and end-call capabilities explicitly;
        share the returned bearer link only with authorized observers.
      operationId: createObserverSession
      parameters:
        - name: study_id
          in: path
          required: true
          schema:
            type: string
            title: Study Id
        - name: call_id
          in: path
          required: true
          schema:
            type: string
            title: Call Id
        - 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/ObserverLinkRequest'
            examples:
              View only:
                summary: Observe a live interview without controls
                description: >-
                  Creates a link valid for 15 minutes with observation
                  permission only.
                value:
                  permissions:
                    - observe
                  expires_in_seconds: 900
              Observe and moderate:
                summary: Observe, steer, or end a live interview
                description: >-
                  Creates a link valid for 15 minutes with all three observer
                  capabilities.
                value:
                  permissions:
                    - observe
                    - steer
                    - end
                  expires_in_seconds: 900
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObserverLinkResponse'
        '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:
    ObserverLinkRequest:
      properties:
        permissions:
          items:
            type: string
            enum:
              - observe
              - steer
              - end
          type: array
          maxItems: 3
          minItems: 1
          title: Permissions
          description: >-
            Defaults to observe, steer, and end. Pass [observe] explicitly for
            view-only access. A read-scoped key can grant all observer
            capabilities.
        expires_in_seconds:
          type: integer
          maximum: 3600
          minimum: 60
          title: Expires In Seconds
          default: 900
      type: object
      title: ObserverLinkRequest
    ObserverLinkResponse:
      properties:
        id:
          type: string
          title: Id
        observer_url:
          type: string
          title: Observer Url
          description: >-
            Short-lived bearer link to the User Intuition observer page. Share
            only with authorized observers.
        expires_at:
          type: string
          format: date-time
          title: Expires At
        permissions:
          items:
            type: string
            enum:
              - observe
              - steer
              - end
          type: array
          title: Permissions
      type: object
      required:
        - id
        - observer_url
        - expires_at
        - permissions
      title: ObserverLinkResponse
    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.