> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ontora.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Question Set



## OpenAPI

````yaml /openapi.json patch /v1/interviews/{interview_id}/question-sets/{set_id}
openapi: 3.1.0
info:
  title: Ontora API
  description: >-
    Ontora's public API. Covers interview campaigns, transcripts, synthesis
    reports, graph queries, webhooks, and workspace management. 


    **Authentication**: endpoints accept either a Clerk JWT (`Authorization:
    Bearer <token>`) or a workspace API key (`X-API-Key: ont_...`). Workspace
    keys are managed via `/v1/api-keys`.
  version: 0.1.0
servers: []
security:
  - ClerkJWT: []
  - WorkspaceApiKey: []
tags:
  - name: interviews
    description: Campaign CRUD, lifecycle, contacts, question sets.
  - name: campaign-insights
    description: Synthesis outputs — cartography, roadmap, personas, conversations.
  - name: interview-query
    description: Graph RAG query over campaign data.
  - name: campaign-reports
    description: Versioned synthesis Reports — manual regenerate, version history.
  - name: interview-export
    description: Markdown / ZIP exports of transcripts and reports.
  - name: api-keys
    description: Manage workspace-scoped API keys for programmatic access.
  - name: webhook-endpoints
    description: Outbound webhook endpoints for automation.
  - name: booking
    description: Public self-scheduling endpoints for interview participants.
  - name: join
    description: Public QR-code / share-link self-registration for campaign participants.
  - name: workspaces
    description: Workspace and membership management.
  - name: vaults
    description: Context vault management.
paths:
  /v1/interviews/{interview_id}/question-sets/{set_id}:
    patch:
      tags:
        - interviews
      summary: Update Question Set
      operationId: >-
        update_question_set_v1_interviews__interview_id__question_sets__set_id__patch
      parameters:
        - name: interview_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Interview Id
        - name: set_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Set Id
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuestionSetUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuestionSetOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    QuestionSetUpdate:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
      type: object
      title: QuestionSetUpdate
    QuestionSetOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        interview_id:
          type: string
          format: uuid
          title: Interview Id
        name:
          type: string
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        sort_order:
          type: integer
          title: Sort Order
        topic_metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Topic Metadata
        questions:
          items:
            $ref: '#/components/schemas/QuestionOut'
          type: array
          title: Questions
          default: []
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - interview_id
        - name
        - description
        - sort_order
        - created_at
      title: QuestionSetOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    QuestionOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        question_set_id:
          type: string
          format: uuid
          title: Question Set Id
        question_text:
          type: string
          title: Question Text
        is_required:
          type: boolean
          title: Is Required
        sort_order:
          type: integer
          title: Sort Order
        question_type:
          $ref: '#/components/schemas/QuestionType'
        options:
          items:
            type: string
          type: array
          title: Options
        component_config:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Component Config
        follow_up_rule:
          $ref: '#/components/schemas/FollowUpRule'
        follow_up_guideline:
          type: string
          title: Follow Up Guideline
          default: ''
        requires_screen_share:
          type: boolean
          title: Requires Screen Share
          default: false
        screen_share_prompt:
          type: string
          title: Screen Share Prompt
          default: ''
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - question_set_id
        - question_text
        - is_required
        - sort_order
        - question_type
        - options
        - follow_up_rule
        - created_at
      title: QuestionOut
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    QuestionType:
      type: string
      enum:
        - open_ended
        - single_choice
        - multiple_choice
        - likert_scale
        - ranking
        - statement
        - range_slider
        - matrix
      title: QuestionType
      description: >-
        Shape of an interview question — drives how the agent delivers and how
        answers get quantified.
    FollowUpRule:
      type: string
      enum:
        - auto
        - none
        - on_short_answers
        - one_followup
        - up_to_three
        - no_followup_allowed
      title: FollowUpRule
      description: >-
        Per-question follow-up budget — controls how aggressively the agent
        probes.
  securitySchemes:
    ClerkJWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk-issued RS256 JWT.
    WorkspaceApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Workspace-scoped API key (prefix: `ont_`).'
    HTTPBearer:
      type: http
      scheme: bearer

````