niiko/developers

Miira · leads y WhatsApp v1 solo lectura

miira.knowledge_search

Busca por palabras en la base de conocimiento que el equipo le cargó al agente de ventas (manuales, casos, respuestas a objeciones) y devuelve hasta 6 fragmentos con su documento y su sección. Solo documentos activos y ya indexados. No es la fuente de un precio: eso es miira.catalog_search.

Última actualización

POST /api/v1/reads/miira.knowledge_search
Alcance del token
miira.knowledge_search@1
Permiso del workspace
api.miira.knowledge_search apagado por defecto
Quién lee
La persona detrás del token, con su rol. Quien deja el workspace deja de leer.
Tres permisos

Un token con ese alcance, que el dueño del workspace haya encendido la lectura, y que el rol de la persona la vea en el producto. Ninguna basta sola. Solo con OAuth →

Petición

campotiporeglas
querystringobligatoriomin 1 · max 500

Respuesta — output cuando status es done

campotiporeglas
foundbooleanobligatorio
fragmentsobject[]obligatorio

fragments[]

campotiporeglas
documentstringobligatorio
sectionstring | nullobligatorio
textstringobligatorio

Ejemplo

# Reads take an OAuth access token, not an API key, and no idempotency key: reading changes nothing.
curl -X POST https://niiko.org/api/v1/reads/miira.knowledge_search \
  -H "Authorization: Bearer $NIIKO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "…"
  }'
# 200 → done · 4xx → refused, with a named reason

Por qué puede negarse

Cada motivo dice quién puede arreglarlo y cómo; detail.message, cuando viene, dice qué hacer. Negativas y códigos HTTP →

invalid_inputrole_forbiddengrant_offreads_need_a_person

En los clientes

@vorluno/niiko-sdkniiko.searchKnowledge()
niiko (Python)niiko.search_knowledge() desde 0.4.0 · aún no está en el registro
niiko-cliniiko read miira.knowledge_search
n8n-nodes-niikoSin lecturas: el nodo lleva una llave, y leer pide una persona por OAuth.
niiko-mcp-servermiira_knowledge_search readOnlyHint

Historial