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

# Get the configuration

> Read the published configuration, or the current draft when the required scope is present.



## OpenAPI

````yaml /openapi.yaml get /v1/configuration
openapi: 3.1.0
info:
  version: 1.0.0
  contact:
    name: Zelinqa
    url: https://docs.zelinqa.ai
  license:
    name: Proprietary — Zelinqa SAS
    identifier: LicenseRef-Zelinqa-Proprietary
  x-contract-status: frozen
  x-jira: NBQ-304
  x-supersedes: openapi/nbq-runtime-v2.openapi.yaml
  x-compatibility-note: docs/api-compat-0.9-to-v1.md
  title: NBQ Engine — API V1
  summary: Public runtime and question-bank configuration contract.
  description: >-
    NBQ Engine's public V1 contract, served from https://api.zelinqa.ai. The
    server resolves the tenant, NBQ instance, and scopes from the API key. Never
    send trusted identity headers from the client. Mutations use
    Idempotency-Key, and existing-session mutations also use state_version.
servers:
  - url: https://api.zelinqa.ai
security:
  - ApiKeyAuth: []
tags:
  - name: sessions
    description: Create, advance, inspect, and close server-side NBQ conversations.
  - name: configuration
    description: Read, edit, audit, compile, and publish a question-bank configuration.
paths:
  /v1/configuration:
    get:
      tags:
        - configuration
      summary: Get the configuration
      description: >-
        Read the published configuration, or the current draft when the required
        scope is present.
      operationId: getConfiguration
      parameters:
        - name: state
          in: query
          required: false
          schema:
            type: string
            enum:
              - published
              - draft
            default: published
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationResponse'
          description: Successful response.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '404':
          $ref: '#/components/responses/UnknownConfiguration'
components:
  schemas:
    ConfigurationResponse:
      type: object
      additionalProperties: false
      required:
        - request_id
        - state
        - objective
        - sub_objectives
        - success_informations
        - questions
      properties:
        request_id:
          type: string
        state:
          type: string
          enum:
            - published
            - draft
        configuration_version:
          type:
            - string
            - 'null'
        draft_revision:
          type:
            - integer
            - 'null'
        published_at:
          type:
            - string
            - 'null'
          format: date-time
        objective:
          $ref: '#/components/schemas/Objective'
        sub_objectives:
          type: array
          items:
            $ref: '#/components/schemas/SubObjective'
        success_informations:
          type: array
          items:
            $ref: '#/components/schemas/SuccessInformation'
        questions:
          type: array
          items:
            $ref: '#/components/schemas/ConfiguredQuestion'
    Objective:
      type: object
      additionalProperties: false
      required:
        - name
        - qualification_level
        - max_turns
        - candidates_per_call
        - order_strength
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
        qualification_level:
          $ref: '#/components/schemas/QualificationLevel'
        max_turns:
          type: integer
          minimum: 1
          maximum: 100
        candidates_per_call:
          type: integer
          minimum: 1
          maximum: 10
        order_strength:
          type: number
          minimum: 0
          maximum: 1
    SubObjective:
      type: object
      additionalProperties: false
      required:
        - id
        - name
        - order_position
        - completion_role
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 128
        name:
          type: string
          minLength: 1
          maxLength: 200
        order_position:
          type: integer
          minimum: 0
        completion_role:
          $ref: '#/components/schemas/CompletionRole'
    SuccessInformation:
      type: object
      additionalProperties: false
      required:
        - id
        - label
        - schema
        - primary_question_id
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 128
        label:
          type: string
          minLength: 1
          maxLength: 200
        schema:
          type: object
          additionalProperties: true
        primary_question_id:
          type: string
          minLength: 1
          maxLength: 128
    ConfiguredQuestion:
      type: object
      additionalProperties: false
      required:
        - id
        - text
        - type
        - sub_objective_id
        - active
        - choices
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 128
        text:
          type: string
          minLength: 1
          maxLength: 4000
        type:
          $ref: '#/components/schemas/QuestionType'
        choices:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/ConfiguredChoice'
        sub_objective_id:
          type: string
          minLength: 1
          maxLength: 128
        active:
          type: boolean
    ErrorEnvelope:
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - request_id
        - details
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          minLength: 1
        request_id:
          type: string
          minLength: 1
        details:
          type: object
          additionalProperties: true
    QualificationLevel:
      type: string
      enum:
        - essential
        - balanced
        - deep
    CompletionRole:
      type: string
      enum:
        - blocking
        - contributing
        - optional
    QuestionType:
      type: string
      enum:
        - open
        - single_choice
        - multiple_choice
        - semi_open
    ConfiguredChoice:
      type: object
      additionalProperties: false
      required:
        - id
        - label
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 128
        label:
          type: string
          minLength: 1
          maxLength: 500
        maps_to_value: {}
    ErrorCode:
      type: string
      enum:
        - unauthorized
        - insufficient_scope
        - idempotency_contention
        - state_version_conflict
        - idempotency_key_reused
        - unknown_session
        - invalid_previous_turn
        - constraint_no_match
        - invalid_choice
        - compiled_artifact_unavailable
        - configuration_validation_failed
        - compilation_in_progress
        - unknown_configuration
        - unknown_compilation
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Unauthorized.
    InsufficientScope:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: InsufficientScope.
    UnknownConfiguration:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: UnknownConfiguration.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: NBQ API key

````