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

# Listar documentos FAQ

> Devuelve los documentos indexados en la colección del tenant.

- Útil para auditar qué conocimiento está disponible para el asistente.




## OpenAPI

````yaml /openapi/openapi-maria.yaml get /faq/documents
openapi: 3.1.0
info:
  title: marIA API
  version: 1.0.0
  description: >
    marIA es el agente de voz de Omniloy que atiende llamadas entrantes de
    pacientes en hospitales y clínicas.

    - Voice / Telefonía: el paciente llama y marIA responde, gestiona citas con
    el EHR/HIS, responde FAQs y escala a humano cuando es necesario.

    - Notificaciones WhatsApp: confirmaciones y recordatorios de cita por
    plantilla aprobada.

    - Centros y servicios: consulta y gestión de centros, especialidades y
    coberturas configuradas en marIA.

    - Base de conocimiento FAQ: documentos que alimentan el conocimiento del
    agente sobre centros y servicios.

    - Llamadas salientes y cuestionarios: programación outbound y cuestionarios
    de seguimiento.

    - Integración EHR/HIS mediante webhooks: marIA ⇄ Hospital para beneficios,
    huecos y citas.

    - Gestión de webhooks: registro y configuración de endpoints para recibir
    eventos de marIA.

    Los webhooks top‑level notifican eventos (p. ej. estado de llamadas, citas)
    firmados con `webhookHmac`.
servers:
  - url: https://{your-prod-endpoint}
    description: Producción
    variables:
      your-prod-endpoint:
        default: your-prod-endpoint
        description: Sustituye este valor por el host real antes de probar la petición.
  - url: https://{your-dev-endpoint}
    description: Staging
    variables:
      your-dev-endpoint:
        default: your-dev-endpoint
        description: Sustituye este valor por el host de staging o desarrollo.
security: []
tags:
  - name: Health
    description: Estado y disponibilidad del servicio.
  - name: Centers
    description: Centros médicos con sus servicios y coberturas configurados en marIA.
  - name: WhatsApp Notifications
    description: Envío de confirmaciones y recordatorios de cita por plantilla de WhatsApp.
  - name: FAQ
    description: >-
      Documentos FAQ para que el agente pueda responder preguntas sobre centros
      y servicios.
  - name: Webhooks - Appointments
    description: Eventos de citas integradas con el EHR/HIS.
  - name: Webhooks - Voice
    description: >-
      Eventos de telefonía (estado de llamada, escalado, respuestas y
      transcripciones).
  - name: Voice Calls
    description: Gestión de llamadas entrantes y salientes registradas en MarIA Core.
  - name: Voice Answers
    description: Acceso y filtrado de respuestas capturadas durante llamadas.
  - name: Voice Transcripts
    description: Acceso a transcripciones y enlaces de grabación.
  - name: Content - Questionnaires
    description: Definición de cuestionarios para llamadas salientes.
  - name: Questionnaire Instances
    description: Estado, revisión y resultados de instancias de cuestionario.
  - name: Scheduling - Time Ranges
    description: Rangos horarios reutilizables para programar llamadas.
  - name: Gestión de webhooks
    description: Configuración y gestión de webhooks; endpoints para integradores.
paths:
  /faq/documents:
    get:
      tags:
        - FAQ
      summary: Listar documentos FAQ
      description: |
        Devuelve los documentos indexados en la colección del tenant.

        - Útil para auditar qué conocimiento está disponible para el asistente.
      operationId: list-faq-documents
      parameters:
        - $ref: '#/components/parameters/LimitParam'
        - $ref: '#/components/parameters/OffsetParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FAQDocumentList'
      security:
        - apiKeyAuth: []
components:
  parameters:
    LimitParam:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
      description: Límite de elementos.
    OffsetParam:
      name: offset
      in: query
      schema:
        type: integer
        minimum: 0
        default: 0
      description: Desplazamiento para paginación.
  schemas:
    FAQDocumentList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FAQDocumentResponse'
    FAQDocumentResponse:
      type: object
      properties:
        documentId:
          type: string
        fileName:
          type: string
        uploadedAt:
          type: string
          format: date-time
        metadata:
          $ref: '#/components/schemas/FAQDocumentMeta'
    FAQDocumentMeta:
      type: object
      properties:
        fileName:
          type: string
        centerId:
          type: string
        description:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API Key proporcionada por Omniloy. La misma key se usa para llamadas
        entrantes y salientes.

````