Skip to main content
POST
/
webhook
/
f71de932-772a-43d6-a7e9-e135c0b03eaa
Responder preguntas con base en el conocimiento del agente
curl --request POST \
  --url https://api.example.com/webhook/f71de932-772a-43d6-a7e9-e135c0b03eaa \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "cómo puedo evaluar",
  "chatbotId": "<chatbot-id>"
}
'
{
  "answer": "Para evaluar, dirígete a la sección Evaluaciones y selecciona el modelo y conjunto de pruebas.",
  "citations": [
    {
      "docId": "kb_01HXY...",
      "title": "Guía de Evaluaciones",
      "url": "https://example.com/docs/evaluaciones",
      "snippet": "Ve a Evaluaciones > Nueva evaluación...",
      "score": 0.86
    }
  ]
}
Este endpoint devuelve respuestas basadas en la Knowledge Base asociada al chatbotId.
  • Autenticación: header X-API-Key (por workspace). Ver API reference → Keys.
  • Requiere: chatbotId y query.

Ejemplo de solicitud

{
  "query": "cómo puedo evaluar",
  "chatbotId": "<chatbot-id>"
}

Comportamiento

  • Busca pasajes/documentos relevantes y genera una respuesta.
  • Si la confianza es baja o no hay resultados, devuelve una respuesta genérica y/o error 404 según configuración.
  • Opcional: control de topK para ajustar el número de pasajes considerados.

Respuesta

  • answer: texto generado.
  • citations[]: referencias a documentos usados (docId, título, url, snippet, score).
Recomendado: validar la respuesta y aplicar umbrales de confianza en producción (ver “Fiabilidad”).

Authorizations

X-API-Key
string
header
required

Incluye tu API Key en el header X-API-Key. Compatible con n8n (API Key simple).

Body

application/json
query
string
required

Pregunta del usuario a responder con el conocimiento.

chatbotId
string
required

ID del chatbot cuyo conocimiento se consultará.

topK
integer
default:5

Número de pasajes/documentos a considerar (opcional).

Required range: 1 <= x <= 20

Response

Respuesta encontrada en la Knowledge Base

answer
string
required

Respuesta generada a partir del conocimiento.

citations
object[]

Referencias a los documentos que sustentan la respuesta (si aplica).