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

# Rechercher dans la base

> Recherche sémantique dans les documents indexés.



## OpenAPI

````yaml openapi.json POST /knowledge-base/search
openapi: 3.1.0
info:
  title: Bookivox API
  version: 1.0.0
  description: >-
    API server-to-server Bookivox. Tous les chemins sont relatifs au préfixe
    `/api/v1/api`. Authentification par en-tête `X-API-Key` (l'en-tête
    `Authorization` est interdit).
servers:
  - url: https://api.bookivox.com/api/v1/api
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Clés API
    description: Créer, lister et archiver les clés API de l'organisation.
  - name: Agents
    description: Créer et piloter les agents vocaux (workflows).
  - name: Templates
    description: Partir d'un modèle d'agent prêt à l'emploi.
  - name: Chat texte
    description: Tester un agent dans une session de chat texte.
  - name: Campagnes
    description: Exécuter un agent en masse sur une liste de contacts.
  - name: Base de connaissance
    description: Gérer et interroger les documents de connaissance.
  - name: Outils
    description: Gérer les outils attachables à un nœud agent.
  - name: Crédits et usage
    description: Consulter le solde, la consommation et les statistiques.
  - name: Téléphonie
    description: >-
      Lire les configurations téléphonie et les numéros (lecture seule via clé
      API).
  - name: Node-types
    description: Catalogue des types de nœuds et de leurs propriétés.
paths:
  /knowledge-base/search:
    post:
      tags:
        - Base de connaissance
      summary: Rechercher dans la base
      description: >-
        Recherche sémantique. Les paramètres sont **`limit`** (nombre de
        résultats) et **`min_similarity`** (seuil), pas `top_k` ni `threshold`.
      operationId: searchKnowledgeBase
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - query
              properties:
                query:
                  type: string
                limit:
                  type: integer
                  minimum: 1
                  maximum: 50
                  default: 5
                document_uuids:
                  type: array
                  items:
                    type: string
                  nullable: true
                min_similarity:
                  type: number
                  minimum: 0
                  maximum: 1
                  nullable: true
            example:
              query: Quels sont les horaires d'ouverture ?
              limit: 5
              min_similarity: 0.7
      responses:
        '200':
          description: Résultats de recherche.
          content:
            application/json:
              example:
                chunks:
                  - chunk_text: ...
                    contextualized_text: ...
                    chunk_index: 3
                    chunk_metadata: {}
                    filename: guide.pdf
                    document_uuid: ...
                    similarity: 0.82
                query: Quels sont les horaires d'ouverture ?
                total_results: 1
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Votre clé API Bookivox. Créez-la dans le dashboard, rubrique Clés API.
        L'en-tête `Authorization` est interdit sur cette surface.

````

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