> ## 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. # Lister les questions > Liste paginée et filtrable du corpus. `format=csv` renvoie le même jeu de données en `text/csv`, colonnes stables et documentées, pour export vers un tableur ou réimport. La pagination est par curseur opaque : passer `cursor` reçu dans `next_cursor` pour obtenir la page suivante. `next_cursor` vaut `null` sur la dernière page. ## OpenAPI ````yaml /openapi.fr.yaml get /v1/configuration/questions openapi: 3.1.0 info: title: NBQ Engine — API V1 version: 1.0.0 summary: Contrat public du runtime NBQ et de la configuration des bases de questions. description: > Contrat public de NBQ Engine V1, servi sur `https://api.zelinqa.ai`. Ce document est la **source de vérité** pour `nbq-sdk` (Python et TypeScript) et pour `nbq-mcp`. Les SDK et le serveur MCP sont générés ou alignés depuis ce contrat, jamais l'inverse. ## Pourquoi V1 succède à 0.9 La version publique déployée aujourd'hui est la bêta `0.9`, déjà servie sous le préfixe `/v1`. La V1 **ajoute** ses routes sous le même préfixe sans en modifier aucune : `POST /v1/next-questions` et `POST /v1/sessions/{session_id}/conversion` restent fonctionnelles et sont marquées dépréciées. La correspondance complète est décrite dans `docs/api-compat-0.9-to-v1.md`. ## Principes contractuels - **Le tenant n'est jamais fourni par le client.** L'authorizer de l'API Gateway publique résout la clé, puis injecte le tenant, le NBQ et les scopes. Tout header `x-tenant-id`, `x-nbq-id` ou `x-scopes` présent dans la requête entrante est écrasé. - **Toute mutation exige `Idempotency-Key`.** Même clé et même corps renvoient la réponse d'origine ; même clé et corps différent produisent `idempotency_key_reused`. - **Toute mutation d'une session existante exige `state_version`**, en contrôle optimiste. - **Les identifiants du tour précédent sont optionnels.** `decision_id`, `question_id` et `outcome` aident NBQ ; leur absence n'est pas une erreur, le moteur les résout depuis la décision en attente et les messages observés. Une valeur explicite du client reste prioritaire sur l'inférence. - **Le verbatim est optionnel.** `user_text` peut être omis quand une réponse structurée ou des mises à jour client suffisent : l'extraction sémantique est alors dégradée, signalée par `degraded_reasons`, mais le moteur reste fonctionnel. - **Aucun interne n'est exposé.** Ni score de sélection, ni preuve sémantique détaillée, ni embedding, ni prompt, ni prototype de réponse, ni matrice compilée n'apparaissent dans une réponse publique. - **Le client ne choisit pas la version de configuration.** La session épingle en interne la version publiée active au moment de sa création. ## Arrêts souples NBQ ne décide pas à la place de l'appelant. Lorsque `max_turns` est atteint, que l'objectif est déjà atteint ou que l'éligibilité normale est vide, `/next` renvoie **encore la meilleure question disponible** et signale la situation dans `warnings`. Un `action: stop` n'est produit que lorsqu'aucune question identifiable n'existe réellement. Les exclusions dures — question inactive, sous-objectif exclu par le client, contrainte stricte de l'appel — ne sont jamais violées, et toute question retournée porte un `question_id` valide. ## Scopes de clé API Une clé porte un ou plusieurs scopes. Studio recommande des clés séparées pour le runtime et pour la gestion, selon le principe du moindre privilège. | Scope | Autorise | |---|---| | `runtime` | les cinq routes de session | | `configuration:read` | `GET /v1/configuration` (publiée) et `GET /v1/configuration/questions` | | `configuration:write` | `POST /v1/configuration/changes` et la lecture du brouillon | Deux niveaux de contrôle se complètent. L'authorizer décide **statiquement**, à partir de la méthode et du chemin : c'est lui qui refuse une clé `runtime` sur `/v1/configuration/publish`. Le service ajoute un contrôle **dynamique** là où le scope dépend du contenu de la requête, que l'authorizer ne voit pas : aujourd'hui le seul cas est `?state=draft`, qui exige `configuration:write` sur une route dont l'authorizer n'exige que `configuration:read`. | `configuration:publish` | `POST /v1/configuration/publish` | Chaque opération déclare le scope exigé dans `x-required-scopes`. Un scope manquant produit `403 insufficient_scope`. ## Frontière de confiance L'API Configuration est implémentée par le service `bo-api` mais atteignable par deux portes qui n'ont pas la même confiance : - via l'**API Gateway publique** (`6nw77hkcib`, `api.zelinqa.ai`), l'authorizer Lambda authentifie la clé et **écrase** `x-tenant-id` et `x-scopes` ; ces headers font alors autorité ; - via l'**API Gateway bo-api** (`jdkpi8qlv5`, `bo-api.zelinqa.ai`), l'authentification vient des guards NestJS et du JWT Cognito ; **tous** les headers `x-tenant-id` et `x-scopes` fournis par l'appelant sont ignorés. Le service distingue obligatoirement l'origine via `requestContext.apiId` avant de construire son contexte d'autorisation. Un JWT valide sur la porte bo-api ne peut jamais obtenir un scope de publication en forgeant un header `x-*`. Ce document ne décrit que la surface publique `api.zelinqa.ai`. 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 servers: - url: https://api.zelinqa.ai description: API publique NBQ security: - ApiKeyAuth: [] tags: - name: sessions description: | Cycle de vie d'une conversation NBQ : création, sélection de la question suivante, mises à jour hors tour, reprise et retour de résultat. - name: configuration description: | Lecture et modification de la configuration éditoriale d'un NBQ, puis publication asynchrone de l'artefact moteur. paths: /v1/configuration/questions: get: tags: - configuration summary: Lister les questions description: > Liste paginée et filtrable du corpus. `format=csv` renvoie le même jeu de données en `text/csv`, colonnes stables et documentées, pour export vers un tableur ou réimport. La pagination est par curseur opaque : passer `cursor` reçu dans `next_cursor` pour obtenir la page suivante. `next_cursor` vaut `null` sur la dernière page. operationId: listConfigurationQuestions parameters: - name: state in: query required: false schema: type: string enum: - published - draft default: published description: | `draft` exige `configuration:write`, contrôlé par le service et non par l'authorizer, qui ne voit pas les paramètres de requête. - name: sub_objective_id in: query required: false schema: type: string minLength: 1 maxLength: 128 - name: active in: query required: false schema: type: boolean description: Filtre sur le drapeau d'activation. - name: type in: query required: false schema: $ref: '#/components/schemas/QuestionType' - name: search in: query required: false schema: type: string minLength: 1 maxLength: 200 description: Recherche textuelle simple sur le libellé de la question. - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 200 default: 50 - name: cursor in: query required: false schema: type: string minLength: 1 maxLength: 512 description: Curseur opaque renvoyé par l'appel précédent. - name: format in: query required: false schema: type: string enum: - json - csv default: json description: | `csv` ignore la pagination par curseur et renvoie l'intégralité du corpus filtré en `text/csv`. responses: '200': description: Page de questions, ou export complet en CSV. content: application/json: schema: $ref: '#/components/schemas/QuestionListResponse' examples: premiere_page: $ref: '#/components/examples/PageDeQuestions' text/csv: schema: type: string example: > id,text,type,choices,sub_objective_id,active q_style,"Quel style de canapé recherchez-vous ?",single_choice,"choice_contemporain|choice_scandinave|choice_classique",so_besoin,true q_budget,"Quel budget souhaitez-vous consacrer au canapé ?",open,,so_budget,true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/InsufficientScope' '404': $ref: '#/components/responses/UnknownConfiguration' components: schemas: QuestionType: type: string enum: - open - single_choice - multiple_choice - semi_open description: | - `open` : réponse libre, aucun choix ; - `single_choice` : un seul choix parmi la liste ; - `multiple_choice` : plusieurs choix possibles ; - `semi_open` : choix proposés, complément libre autorisé via `structured_answer.free_text`. Le mode de sélection est porté par le type lui-même : aucun champ `selection_mode` séparé n'existe en V1. QuestionListResponse: type: object additionalProperties: false required: - request_id - state - questions - next_cursor properties: request_id: type: string state: type: string enum: - published - draft questions: type: array items: $ref: '#/components/schemas/ConfiguredQuestion' next_cursor: type: - string - 'null' description: Curseur de la page suivante, `null` sur la dernière page. total: type: integer minimum: 0 description: Nombre total de questions correspondant au filtre. ConfiguredQuestion: type: object additionalProperties: false required: - id - text - type - sub_objective_id - active - choices description: > Champs volontairement absents en V1 : `must_ask`, `requirement_policy`, `importance`, `editor_weight`, `cost_profile`, sensibilité, effort et `expected_answer_elements`. Une question devient nécessaire parce qu'elle est la meilleure manière encore disponible d'obtenir une information manquante, pas parce qu'un éditeur l'a marquée obligatoire. 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 description: Exactement un sous-objectif. active: type: boolean ErrorEnvelope: type: object additionalProperties: false required: - code - message - request_id - details description: Enveloppe uniforme de toutes les erreurs métier. properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string minLength: 1 request_id: type: string minLength: 1 details: type: object additionalProperties: true 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: description: | Valeur produite pour l'information de réussite lorsque ce choix est sélectionné. Permet le mapping déterministe sans appel LLM. ErrorCode: type: string description: Catalogue fermé des erreurs métier V1. 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 examples: PageDeQuestions: summary: Première page du corpus publié value: request_id: req_1006 state: published total: 3 next_cursor: null questions: - id: q_style text: Quel style de canapé recherchez-vous ? type: single_choice sub_objective_id: so_besoin active: true choices: - id: choice_contemporain label: Contemporain - id: choice_scandinave label: Scandinave - id: choice_classique label: Classique - id: q_budget text: Quel budget souhaitez-vous consacrer au canapé ? type: open sub_objective_id: so_budget active: true choices: [] responses: Unauthorized: description: > Clé absente, malformée, inconnue, révoquée, expirée, ou rattachée à un NBQ suspendu. Le refus vient de l'authorizer de la passerelle, avant que la requête n'atteigne le service : le corps est donc produit par la passerelle et peut ne pas suivre l'enveloppe d'erreur métier. La distinction avec `403` est nette : `401` signifie « je ne sais pas qui vous êtes », `403` signifie « je sais qui vous êtes, mais cette clé ne porte pas le scope requis ». content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: code: unauthorized message: Clé d'intégration absente ou invalide. request_id: req_9000 details: {} InsufficientScope: description: > La clé est valide mais ne porte pas le scope exigé par l'opération. Une clé absente ou invalide produit `401` au niveau de la passerelle, avant d'atteindre le service. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: code: insufficient_scope message: Cette clé ne permet pas de publier une configuration. request_id: req_9001 details: required_scopes: - configuration:publish granted_scopes: - configuration:read - configuration:write UnknownConfiguration: description: > Aucune configuration ne correspond à l'état demandé — par exemple un brouillon qui n'a jamais été créé. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: code: unknown_configuration message: Aucun brouillon n'existe pour cette configuration. request_id: req_9008 details: state: draft securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: NBQ API key description: > Clé d'intégration préfixée `nbq_live_`, envoyée dans `Authorization: Bearer nbq_live_…` et résolue par l'authorizer Lambda de l'API Gateway publique. L'authorizer valide la clé, puis **injecte** en amont du service les headers de contexte `x-tenant-id`, `x-nbq-id` et `x-scopes` — `x-scopes` étant la liste des scopes de la clé séparés par des **virgules**, par exemple `runtime,configuration:read`. Ces headers ne sont jamais acceptés depuis le client : toute valeur entrante est écrasée. Une clé absente ou invalide produit `401` au niveau de la passerelle ; une clé valide sans le scope requis produit `403` avec le code `insufficient_scope`. ````