Knowledge Base

Knowledge Base API

Documentación de la API de Knowledge Base

Servidor base: https://services.leadconnectorhq.com

Endpoints

• GET /knowledge-bases/faqs — Obtener todos los FAQs by knowledge base with pagination support
• POST /knowledge-bases/faqs — Crear a new FAQ inside knowledge base
• PUT /knowledge-bases/faqs/{id} — Actualizar an existing knowledge base FAQ
• DELETE /knowledge-bases/faqs/{id} — Eliminar an existing knowledge base FAQ
• GET /knowledge-bases/crawler — Obtener todos los trained page links by knowledge base
• POST /knowledge-bases/crawler — Start crawling and discover pages for training
• DELETE /knowledge-bases/crawler — Eliminar trained pages
• GET /knowledge-bases/crawler/status — Obtener crawling status for the latest operation
• POST /knowledge-bases/crawler/train — Train discovered website pages and ingest into the knowledge base
• GET /knowledge-bases/{knowledgeBaseId} — Obtener knowledge base by Id
• DELETE /knowledge-bases/{knowledgeBaseId} — Eliminar a knowledge base
• PUT /knowledge-bases/{id} — Actualizar a knowledge base
• GET /knowledge-bases/ — Obtener todos los knowledge bases for a location by location Id (paginated)
• POST /knowledge-bases/ — Crear a new knowledge base (max 15 knowledge bases per location)

GET /knowledge-bases/faqs

Obtener todos los FAQs by knowledge base with pagination support Retrieves FAQs for a knowledge base. Supports pagination using limit and lastFaqId parameters.

Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - knowledgeBaseId (query, string) (requerido) — knowledge base Id as string - locationId (query, string) (requerido) — location Id as string - limit (query, number) — Limit the number of FAQs returned - lastFaqId (query, string) — Last FAQ Id for pagination (cursor-based)

Respuestas: - 200 — FAQs retrieved successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable - 500 — Error interno del servidor

POST /knowledge-bases/faqs

Crear a new FAQ inside knowledge base Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — location Id as string - question (requerido) — string — faq question as a string - answer (requerido) — string — faq answer as a string - knowledgeBaseId (requerido) — string — knowledge base Id as string

Respuestas: - 201 — FAQ created successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable - 500 — Error interno del servidor

PUT /knowledge-bases/faqs/{id}

Actualizar an existing knowledge base FAQ Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — faq Id as string

Cuerpo de la peticion (application/json): - question (requerido) — string — faq question as a string - answer (requerido) — string — faq answer as a string

Respuestas: - 200 — FAQ updated successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable - 500 — Error interno del servidor

DELETE /knowledge-bases/faqs/{id}

Eliminar an existing knowledge base FAQ Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — faq Id as string

Respuestas: - 200 — FAQ deleted successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable - 500 — Error interno del servidor

GET /knowledge-bases/crawler

Obtener todos los trained page links by knowledge base Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - knowledgeBaseId (query, string) (requerido) — knowledge base Id as string - locationId (query, string) (requerido) — location Id as string - page (query, number) — Page number - pageLength (query, number) — Records per page - query (query, string) — query to filter on url links

Respuestas: - 200 — Trained page links retrieved successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable - 500 — Error interno del servidor

POST /knowledge-bases/crawler

Start crawling and discover pages for training Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location Id as string - url (requerido) — string — Website URL as string - option (requerido) — string — Mode as string - knowledgeBaseId (requerido) — string — knowledge base Id as string

Respuestas: - 201 — Crawling and discovery started successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable - 500 — Error interno del servidor

DELETE /knowledge-bases/crawler

Eliminar trained pages Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - knowledgeBaseId (requerido) — string — knowledge base Id as string - locationId (requerido) — string — location Id as string - urlIds (requerido) — array — List of trained urls ids ( fetched from the Get all trained page links by knowledge base endpoint)

Respuestas: - 200 — Selected pages deleted successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable - 500 — Error interno del servidor

GET /knowledge-bases/crawler/status

Obtener crawling status for the latest operation Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Location Id as string - operationId (query, string) (requerido) — operation id as string - knowledgeBaseId (query, string) (requerido) — Id de base de conocimiento

Respuestas: - 200 — Operation status fetched successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable - 500 — Error interno del servidor

POST /knowledge-bases/crawler/train

Train discovered website pages and ingest into the knowledge base Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location Id as string - urlIds (requerido) — array — List of Object ids of the discovered urls - knowledgeBaseId (requerido) — string — knowledge base id - operationId (requerido) — string — operation id as string

Respuestas: - 201 — Pages trained successfully - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable - 500 — Error interno del servidor

GET /knowledge-bases/{knowledgeBaseId}

Obtener knowledge base by Id Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - knowledgeBaseId (path, string) (requerido) —

Respuestas: - 200 — Knowledge base by Id retrieved successfully - 400 — Peticion invalida - 401 — No autorizado

DELETE /knowledge-bases/{knowledgeBaseId}

Eliminar a knowledge base Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - knowledgeBaseId (path, string) (requerido) —

Respuestas: - 200 — Knowledge base deleted successfully - 400 — Peticion invalida - 401 — No autorizado

PUT /knowledge-bases/{id}

Actualizar a knowledge base Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) —

Cuerpo de la peticion (application/json): - name — string — field to update the name of the knowledge base - description — string — field to update the description of the knowledge base

Respuestas: - 200 — Knowledge base updated successfully - 400 — Peticion invalida - 401 — No autorizado

GET /knowledge-bases/

Obtener todos los knowledge bases for a location by location Id (paginated) Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — - query (query, string) — search query for knowledge base name - limit (query, number) — Maximum number of knowledge bases to return - lastKnowledgeBaseId (query, string) — Id of the last knowledge base from the previous page (for pagination)

Respuestas: - 200 — Paginated knowledge bases retrieved successfully - 400 — Peticion invalida - 401 — No autorizado

POST /knowledge-bases/

Crear a new knowledge base (max 15 knowledge bases per location) Parametros: - Authorization (header, string) (requerido) — Token de acceso - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - name (requerido) — string - description — string - locationId (requerido) — string

Respuestas: - 201 — Knowledge base created successfully - 400 — Peticion invalida - 401 — No autorizado