--- title: "Ask Eddy AI API" slug: "ask-eddy-ai-api" updated: 2026-06-18T08:49:22Z published: 2026-06-18T08:49:22Z canonical: "docs.document360.com/ask-eddy-ai-api" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.document360.com/llms.txt > Use this file to discover all available pages before exploring further. # Ask Eddy AI API La **API Pública de Eddy AI** te permite integrar la búsqueda asistiva de Eddy AI directamente en tu propia plataforma o servicio, para que los usuarios puedan consultar tu base de conocimientos sin necesidad de visitar tu página de documentación. Llamas al endpoint de la API con un prompt y recibes una respuesta generada por IA extraída del contenido de tu base de conocimientos. Esto te da control total sobre la interfaz de búsqueda, incluyendo su aspecto, dónde aparece y cómo se comporta dentro de tu producto. La API está disponible a través del [hub de la API Document360](https://apihub.document360.io/index.html). NOTA Para una lista completa de idiomas soportados por Eddy AI, consulte [soporte multilingüe para Eddy AI Search Suite](/help/docs/es/ai-search-suite#multilingual-support-for-eddy-ai-search-suite). --- ## Cuándo usar la API pública de Eddy AI - **Búsqueda integrada en tu producto** — respuestas superficiales a la base de conocimientos dentro de la interfaz de tu aplicación, sin redirigir a los usuarios a un sitio de documentación separado. - **Interfaces de búsqueda personalizadas** : crea una experiencia de búsqueda que coincida con el esquema de colores, la terminología y el diseño de tu marca. - **Flujos de trabajo automatizados de soporte** — integra Eddy AI en chatbots, sistemas de tickets o flujos de incorporación que consultan tu base de conocimiento de forma programática. --- ## Antes de que empieces - La API Pública de Eddy AI debe estar habilitada en la configuración de tu proyecto (consulta [Cómo habilitar la API Pública](https://docs.document360.com/docs/es/ask-eddy-ai-api#how-to-enable-the-public-api) más abajo). - Necesitas un token API con el método POST activado (ver [Cómo crear un token API](https://docs.document360.com/docs/es/ask-eddy-ai-api#how-to-create-an-api-token) más abajo). - El interruptor **de búsqueda asistida por IA** requiere que al menos una casilla de entrega (**API pública** u otra) siga seleccionada — desmarcar todas las casillas desactivará automáticamente el interruptor. --- ## Cómo habilitar la API pública 1. En el portal de la Base de Conocimientos, selecciona **Configuración** (⚙) en la barra de navegación izquierda. 2. En el panel de navegación izquierdo, ve a **funciones de IA** > **Eddy AI**. 3. Amplía el **acordeón de la suite de búsqueda de IA** . 4. En la sección **de búsqueda asistida por IA** , selecciona la casilla **de verificación de la API Pública** . ![Eddy AI settings page showing the AI assistive search section with the Public API checkbox selected.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/Screenshot-Eddy_ai_public_api.png) ADVERTENCIA Si la API pública no está habilitada, todas las llamadas a la API devolverán una `500` respuesta (error de servicio) o `400` (acceso a la API deshabilitado). Asegúrate de que la casilla esté seleccionada antes de hacer cualquier llamada a la API. --- ## Cómo crear un token API Necesitas un token API para autenticar las solicitudes a la API pública de Eddy AI. 1. En el portal de la Base de Conocimientos, selecciona **Configuración** (⚙) en la barra de navegación izquierda. 2. En el panel de navegación izquierdo, ve al **portal de la base de conocimiento** > **Tokens de API**. 3. Haz clic **en Crear API Token**, introduce el nombre de un token y configura el método como **POST**. 4. Haz **clic en Crear**, luego copia el token de API generado y guárdalo de forma segura. --- ## Cómo probar la API Puedes probar la API pública de Eddy AI de dos maneras: a través de la documentación de la API de Document360 o a través del hub de la API Swagger. ### Prueba mediante documentación API 1. Ve a [la documentación de la API de Document360](https://apidocs.document360.com/apidocs/perform-ai-assistive-search-ask-eddy-within-project-version). 2. En el lado derecho de la página, selecciona la sección **Pruébalo** . 3. En el campo **Token** , introduce tu token de API. 4. Rellena los campos **de Cuerpo** : | Campo | Descripción | | --- | --- | | **Prompt** | La pregunta o consulta que enviar a Eddy AI | | **ID de Versión** | El ID de tu base de conocimiento versión del proyecto | | **Código de lenguaje** | El código del lenguaje para la consulta (por ejemplo, `en`) | 1. Haz **clic en Pruébalo y ve la respuesta**. La respuesta generada por IA aparece a continuación. ![Document360 API documentation showing the Try it section with Token, Prompt, Version ID, and Language code fields filled in.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/5_Screenshot-Ask_Eddy_in_API_Documentation.png) ### Test mediante Swagger 1. Ve al [hub de la API de Swagger](https://apihub.document360.io/index.html). La API de IA de Ask Eddy está listada en **versiones del proyecto**. 2. En la esquina superior derecha, haz clic **en Autorizar**. 3. En el panel **de Autorizaciones disponibles** , pega tu token API y haz clic **en Autorizar**. 4. Navega a **las versiones del proyecto** > `/v2/ProjectVersions/ask-Eddy AI` y haz clic **en Pruébalo**. El cuadro de solicitud por defecto aparece con los siguientes campos para completar: | Campo | Descripción | | --- | --- | | **Prompt** | La pregunta o consulta que enviar a Eddy AI | | **ID de Versión** | Recupera esto desde el `/v2/ProjectVersions` punto final | | **Código de lenguaje** | El código del lenguaje para la consulta | Para recuperar tu ID de versión, llama primero al `/v2/ProjectVersions` endpoint: ![Swagger API hub showing the /v2/ProjectVersions endpoint response with the version ID highlighted.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/6_Screenshot-Updating_Getting_Project_version.png) 1. Haz **clic en Ejecutar**. Una respuesta exitosa contiene la respuesta generada por IA y los detalles del artículo fuente. ![Screen recording of the Swagger API hub — authorizing with an API token and executing the Ask Eddy AI endpoint.](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/4_ScreenGIF-Using_Eddy_API_Token_in_Swagger.gif) NOTA Si recibes un error de "servicio no disponible" en Swagger, verifica que la casilla **de verificación de la API pública** esté seleccionada en **Configuración** > **funciones de IA** > **Eddy AI** **> suite de búsqueda de AI**. --- ## Mejores prácticas - **Guarda tokens API de forma segura** — trata tu token API como un secreto. No lo expongas en código del lado del cliente ni en repositorios públicos. Gíralo si está comprometido. - **Utiliza el tipo de ID correcto para tu contenido** — los artículos estándar usan `articleID`, pero los artículos de categoría de página requieren `categoryID`. Usar el ID incorrecto devuelve campos nulos en la respuesta. Consulta las [preguntas frecuentes](/docs/es/ask-eddy-ai-api#faq) para más detalles. - **Especifica el código del idioma de forma explícita** — siempre pasa el código correcto en el cuerpo de la solicitud para asegurarte de que Eddy AI busca la versión correcta de tu base de conocimientos. - **Gestionar respuestas de error** — implementar el manejo de errores para `400` respuestas (acceso a la API deshabilitado) y `500` (error de servicio). Ambos suelen indicar que la casilla de verificación de la API pública no está activada. --- ## Preguntas frecuentes   **¿Por qué los campos de artículo fuente devolven nulo en la respuesta de la API?**               Esto ocurre cuando consultas un artículo **de categoría de páginas** usando un `articleID`archivo de . Para el contenido de la categoría de página, los `article_id`campos , `article_title`, y `article_slug` se devuelve `null` porque el contenido es a nivel de categoría, no a nivel de artículo. Usa el `categoryID` lugar para recuperar los datos correctos. Una respuesta de la API de Pagecategory es la siguiente:       ``` { ```           **¿Por qué recibo un error 400 o 500 al llamar a la API?**               Una `400` respuesta (acceso a la API deshabilitado) o `500` (error de servicio) significa que la API pública no está habilitada en tu proyecto. Ve a **Configuración** > **funciones de IA** > **Eddy AI** **> AI** Search suite y confirma que la casilla **de la API Pública** está seleccionada.           **¿Se puede integrar la Documentación con una herramienta de terceros o un chatbot?**               Sí, puedes usar el endpoint de Ask Eddy AI para obtener respuestas de la documentación y proporcionar respuestas a través de la herramienta o chatbot de terceros.