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

# Render Visible Questionnaire

> Render visible content plus selected saved setup, without writes or invitations.



## OpenAPI

````yaml /openapi.json post /v1/interviews/{interview_id}/export/questionnaire.pdf
openapi: 3.1.0
info:
  title: Ontora API
  description: >-
    Ontora's public API. Covers interview campaigns, contacts, transcripts,
    question results, synthesis reports, graph queries, exports, and outbound
    webhooks. 


    **Authentication**: most endpoints accept either a Clerk JWT
    (`Authorization: Bearer <token>`) or a workspace API key (`X-API-Key:
    ont_...`). Create keys in the dashboard under **Developer → API Keys**. 


    This reference is the supported public surface. Paths not listed here are
    internal and may change without notice.
  version: 0.1.0
servers: []
security:
  - ClerkJWT: []
  - WorkspaceApiKey: []
tags:
  - name: interviews
    description: Campaign CRUD, lifecycle, contacts, question sets.
  - name: campaign-insights
    description: Campaign conversations and recording downloads.
  - name: campaign-reports
    description: Synthesis Reports — regenerate, generation status, current version.
  - name: question-results
    description: Results for structured campaign questions.
  - name: interview-query
    description: Graph RAG query over campaign data.
  - name: insights-chat
    description: Durable full-corpus analysis runs.
  - name: interview-export
    description: >-
      Markdown / ZIP / PDF exports of transcripts, responses, reports and
      questionnaires.
  - name: protected-corpus
    description: Hash-verified raw-corpus access for Confidential analysis keys.
  - name: people
    description: Workspace people directory that feeds campaign contacts.
  - name: webhook-endpoints
    description: Outbound webhook endpoints for automation.
paths:
  /v1/interviews/{interview_id}/export/questionnaire.pdf:
    post:
      tags:
        - interview-export
      summary: Render Visible Questionnaire
      description: >-
        Render visible content plus selected saved setup, without writes or
        invitations.
      operationId: >-
        render_visible_questionnaire_v1_interviews__interview_id__export_questionnaire_pdf_post
      parameters:
        - name: interview_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Interview 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/QuestionnaireDocument'
      responses:
        '200':
          description: Successful Response
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    QuestionnaireDocument:
      properties:
        name:
          type: string
          maxLength: 300
          title: Name
        locale:
          type: string
          enum:
            - en
            - de
          title: Locale
          default: en
        goal:
          type: string
          title: Goal
          default: ''
        description:
          type: string
          title: Description
          default: ''
        success_criteria:
          type: string
          title: Success Criteria
          default: ''
        interview_context_for_employee:
          type: string
          title: Interview Context For Employee
          default: ''
        welcome_screen:
          type: string
          title: Welcome Screen
          default: ''
        closing_message:
          type: string
          title: Closing Message
          default: ''
        topics:
          items:
            $ref: '#/components/schemas/QuestionnaireTopic'
          type: array
          maxItems: 200
          title: Topics
        sections:
          items:
            type: string
            enum:
              - briefing
              - guide
              - messages
              - settings
              - participants
          type: array
          maxItems: 5
          minItems: 1
          title: Sections
      type: object
      required:
        - name
        - topics
      title: QuestionnaireDocument
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    QuestionnaireTopic:
      properties:
        name:
          type: string
          title: Name
          default: ''
        goal:
          type: string
          title: Goal
          default: ''
        success_criteria:
          items:
            type: string
          type: array
          title: Success Criteria
        success_threshold:
          type: string
          title: Success Threshold
          default: ''
        mentions:
          type: string
          title: Mentions
          default: ''
        section_type:
          type: string
          title: Section Type
          default: questions
        survey_position:
          anyOf:
            - type: string
            - type: 'null'
          title: Survey Position
        questions:
          items:
            $ref: '#/components/schemas/QuestionnaireQuestion'
          type: array
          maxItems: 1000
          title: Questions
      type: object
      title: QuestionnaireTopic
    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
    QuestionnaireQuestion:
      properties:
        text:
          type: string
          maxLength: 20000
          title: Text
          default: ''
        question_type:
          $ref: '#/components/schemas/QuestionType'
          default: open_ended
        is_required:
          type: boolean
          title: Is Required
          default: true
        options:
          items:
            type: string
          type: array
          maxItems: 500
          title: Options
        component_config:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Component Config
        follow_up_rule:
          $ref: '#/components/schemas/FollowUpRule'
          default: auto
        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: ''
      type: object
      title: QuestionnaireQuestion
    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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.