Documentación de referencia completa para todas las API de la plataforma Knowledge Base.
Usa la referencia de API cuando conozcas la operación que quieres implementar y necesites el punto final actual, parámetros, esquemas de solicitud y respuesta, e información de estado.
Abrir la referencia de API
Usa la referencia de Swagger como la fuente autorizada para las definiciones de puntos finales actuales y los detalles de implementación.
Qué puedes encontrar en la referencia de API
La referencia de API proporciona detalles de implementación para las operaciones disponibles, incluyendo:
- Métodos HTTP y rutas de puntos finales.
- Parámetros de solicitud.
- Esquemas de solicitud y respuesta.
- Información de respuesta y estado.
Las API disponibles cubren áreas funcionales como:
- Colecciones y acceso a colecciones.
- Documentos y procesamiento de documentos.
- Inferencia de IA.
- Archivos adjuntos.
- Etiquetas de documento.
- Usuarios y organizaciones.
- Comentarios.
- Configuración.
- Analytics y creación de informes.
- Integraciones de bots.
Usa Empezar con la Knowledge Base API si necesitas una introducción al modelo de recursos de API, ciclo de vida de procesos de documento, comportamiento de inferencia o flujo de solicitud típico.
Solucionar problemas de solicitudes de API
Las respuestas de API incluyen una cabecera de respuesta X-Request-ID que identifica la solicitud a través de los servicios de Knowledge Base.
Captura el X-Request-ID al solucionar problemas de una solicitud fallida o al contactar con el soporte.Además, conserva el estado HTTP, los detalles de la respuesta, el punto final y el momento aproximado de la solicitud.
