Documentación de Syncanix
Todo lo que necesitas para descubrir tu API, integrar el widget de chat, conectar un cliente MCP y lanzar un asistente de IA que realiza acciones reales para tus usuarios, alojado en la UE y en seis idiomas.
Empieza aquí
- Inicio rápidoDe tu API actual a un asistente funcionando en tu aplicación, en unos 90 minutos.
- Integra el widget en tu appTodas las formas de poner el widget de Syncanix en tu sitio: la etiqueta de script, single-page apps, montaje en línea, identidad y CSP.
- Autenticar a tus usuariosLas cuatro formas en que el widget puede autenticar a tus propios usuarios finales y cómo elegir la que encaja con tu stack.
- Conectar un clienteConecta Claude Desktop, Cursor, ChatGPT y otros clientes MCP a tu espacio de trabajo.
Introducción
- ¿Qué es Syncanix?Syncanix convierte tu API actual en un asistente de IA con el que tus usuarios pueden conversar, integrado en tu aplicación y disponible para clientes de IA mediante MCP.
- Cómo funciona SyncanixDe un solo comando de descubrimiento a un asistente en funcionamiento: cómo el catálogo de capacidades conecta la CLI, el widget, la superficie de chat y el servidor MCP.
- Visión general de la arquitecturaCómo Syncanix conecta a tus usuarios, tu API y la IA, y dónde se ejecuta todo.
- Idiomas y RTLSyncanix funciona en seis idiomas de forma nativa, con soporte completo de derecha a izquierda para el árabe y el hebreo.
- GlosarioTérminos clave usados en la documentación de Syncanix.
- Preguntas frecuentesRespuestas claras a las preguntas que la gente hace con más frecuencia sobre Syncanix: configuración, qué puede hacer el asistente, seguridad y datos, el widget, facturación e idiomas.
Primeros pasos
Conceptos básicos
- El catálogo de capacidadesLa lista estructurada de lo que tu API puede hacer: se descubre una vez, la editas tú y la leen todas las superficies.
- El navegador es la puertaEl modelo de seguridad de Syncanix en una sola idea: el modelo de lenguaje nunca guarda las credenciales de tus usuarios.
- Lo que el asistente puede y no puede hacerUn resumen en lenguaje sencillo de exactamente qué está autorizado a hacer el asistente de IA en tu nombre, qué nunca puede hacer y cómo se comprueba cada acción de riesgo.
- Identidad y autenticaciónSyncanix usa tu proveedor de identidad actual; nunca se convierte en el almacén de contraseñas de tus usuarios.
- Confirmación de acciones y riesgoCómo decide Syncanix qué se ejecuta automáticamente y qué necesita un sí humano.
- Modos de representaciónCómo muestra los resultados el asistente: componentes integrados, tus propios componentes o llevar al usuario a la página correcta.
- Fiabilidad y enrutamiento de modelosCómo Syncanix sigue respondiendo: varios proveedores de modelos, tus propias claves y enrutamiento en la UE.
- Memoria y conocimientoQué recuerda el asistente entre sesiones y el conocimiento en el que se apoya para responder.
CLI
- La CLI de SyncanixDescubre tu API y gestiona tu catálogo desde la línea de comandos, sin necesidad de instalar nada.
- syncanix initDescubre tu API, construye el catálogo de capacidades y lo sube, con enriquecimiento por IA sujeto a consentimiento.
- Más comandos de la CLIInicia sesión, importa un esquema, ejecuta el entorno local, diagnostica, registra un servidor MCP externo y aplica superposiciones de catálogo.
- Archivos de configuraciónLos archivos que la CLI lee y escribe: reglas de exclusión, configuración de la CLI, el catálogo, tu registro de consentimiento, las credenciales y la superposición de catálogo.
- Variables de entorno y códigos de salidaLas variables de entorno que lee la CLI y los códigos de salida que devuelve.
- Compatibilidad de frameworksLos lenguajes y frameworks que la CLI de descubrimiento puede leer automáticamente, y qué hacer cuando el tuyo no es uno de ellos.
Guías por framework
- Syncanix con ExpressConvierte una API Express en preparada para agentes: qué lee el descubrimiento, cómo ejecutarlo y cómo publicar la superficie de chat y el servidor MCP.
- Syncanix con NestJSConvierte una API NestJS en preparada para agentes: qué lee el descubrimiento, cómo ejecutarlo y cómo publicar la superficie de chat y el servidor MCP.
- Syncanix con Next.jsConvierte una app Next.js en preparada para agentes: qué lee el descubrimiento, cómo ejecutarlo y cómo publicar la superficie de chat y el servidor MCP.
- Syncanix con FastifyConvierte una API Fastify en preparada para agentes: qué lee el descubrimiento, cómo ejecutarlo y cómo publicar la superficie de chat y el servidor MCP.
- Syncanix con FastAPIConvierte un servicio FastAPI en preparado para agentes: qué lee el descubrimiento, cómo ejecutarlo y cómo publicar la superficie de chat y el servidor MCP.
- Syncanix con DjangoConvierte un proyecto Django en preparado para agentes: qué lee el descubrimiento, cómo ejecutarlo y cómo publicar la superficie de chat y el servidor MCP.
- Syncanix con RailsConvierte una API Rails en preparada para agentes: qué lee el descubrimiento, cómo ejecutarlo y cómo publicar la superficie de chat y el servidor MCP.
- Syncanix con LaravelConvierte una API Laravel en preparada para agentes: qué lee el descubrimiento, cómo ejecutarlo y cómo publicar la superficie de chat y el servidor MCP.
Panel
- El panelDonde configuras tu espacio de trabajo —el catálogo, la personalidad, el conocimiento, el diseño, el equipo y la facturación— en un solo lugar.
- Catálogo y capacidadesExplora las capacidades descubiertas y afina cada una: su descripción, permisos, riesgo y más.
- GobiernoControla exactamente qué puede hacer tu agente y quién puede usar cada herramienta: habilitación y aprobación de capacidades, disponibilidad por usuario y las acciones que tu widget registra en la página.
- Endpoints personalizados y disponibilidad de herramientasAñade capacidades que el asistente puede invocar más allá de tus rutas descubiertas, y controla a qué usuarios se ofrece cada herramienta.
- Servidores MCP externosRegistra servidores MCP que tú alojas para que Syncanix les reenvíe las llamadas a herramientas, opcionalmente actuando como el usuario final con sesión iniciada.
- PromptsDé al asistente una voz, un prompt de sistema y un comportamiento de rechazo claro; después dirija un perfil a los visitantes a los que va destinado, impleméntelo de forma gradual y compruebe cómo funcionó.
- Conocimiento y documentosConecta fuentes de contenido para que el asistente pueda responder a partir de tu documentación, y ajusta lo que recupera.
- Diseño y el Estudio de Diseño del WidgetDa estilo al widget para que encaje con tu marca: tokens de tema, componentes y el estudio de diseño por organización.
- Reglas de páginaHaz que el asistente se comporte de otra forma en páginas concretas de tu sitio.
- PlaygroundHabla con tu agente igual que lo harán tus usuarios —el widget real, tu diseño activo, respuestas en vivo— antes de integrarlo.
- Registros de conversación y de usoRevisa cómo se resolvió cada conversación, lee transcripciones individuales e inspecciona el registro de uso y coste por evento.
- Monitorización, coste y auditoríaObserva el rendimiento del asistente, lo que cuesta y un registro completo de lo ocurrido.
- Registro de auditoríaUn registro de solo anexión y a prueba de manipulaciones de cada edición de anulaciones, promoción, vista de transcripción y acción sobre claves de API en tu espacio de trabajo.
- Bandeja de traspasosLa cola de conversaciones de usuarios finales que el agente ha escalado a un operador humano.
- Topes de gasto, límites de tasa y alarmasPon techos estrictos al gasto y al tráfico, y recibe avisos antes de que un medidor de uso se agote.
- Entornos y promociónConfigura con seguridad en desarrollo y luego promueve a producción tras una verificación de evaluación.
- Equipo y rolesInvita a tu equipo y da a cada persona el nivel de acceso adecuado con cinco roles claros.
- AjustesClaves, orígenes, tus propias claves de modelo, federación de identidad, límites, facturación y descuentos.
Widget
- El widgetIntegra el widget de chat de Syncanix en tu aplicación con una sola etiqueta de script: aislado, diferido y acorde a tu marca.
- Integra el widget en tu appTodas las formas de poner el widget de Syncanix en tu sitio: la etiqueta de script, single-page apps, montaje en línea, identidad y CSP.
- Insertar en una app móvilLleva el agente de Syncanix a una app de React Native o Flutter cargando el widget web en un WebView, sin necesidad de un SDK nativo.
- Configuración del widgetConfigura el widget con atributos data-* en la etiqueta de script.
- API en tiempo de ejecución del widgetControla el widget desde JavaScript mediante el objeto window.syncanix.
- Extender el widgetRegistra tus propios componentes React, acciones de página y fuentes de datos en vivo para que el asistente renderice tu interfaz y actúe dentro de tu app.
- Tematizar el widgetEl widget se adapta a tu marca automáticamente, con control total cuando lo quieras.
- CSS personalizadoLa vía de escape: reestiliza cualquier superficie del widget con CSS sin procesar cuando los controles de tokens del estudio no alcanzan.
- Tamaños y modosEl widget viene en cinco tamaños y dos modos de diseño: elige el que encaje en cada lugar donde lo uses.
- La experiencia de chatLo que ven tus usuarios en una conversación: respuestas en streaming, sugerencias, tarjetas de acción, divulgaciones y más.
- Crear una experiencia personalizadaHasta dónde puedes personalizar el chat de Syncanix: desde el montaje en línea y tus propios componentes hasta un tema completo y la API en tiempo de ejecución.
- Accesibilidad y RTLEl widget cumple WCAG 2.1 AA y se dispone correctamente en idiomas de derecha a izquierda.
Servidor MCP
- El servidor MCPCada espacio de trabajo obtiene su propio servidor MCP, para que clientes de IA como Claude Desktop, Cursor y ChatGPT accedan a tus capacidades.
- Conectar un clienteConecta Claude Desktop, Cursor, ChatGPT y otros clientes MCP a tu espacio de trabajo.
- Cómo funciona el inicio de sesión MCPLos clientes MCP se autentican con OAuth 2.1, federado a tu proveedor de identidad; Syncanix nunca guarda las credenciales de tus usuarios.
- Herramientas y ejecuciónQué expone el servidor MCP, cómo se marcan las herramientas de riesgo y cómo se ejecutan realmente las llamadas.
- Límites y endpoints de MCPLos límites de sesión y los endpoints de OAuth y de transporte que expone el servidor MCP.
Autenticación y acceso
- Autenticación y accesoCómo inician sesión las personas en Syncanix: tu equipo en el panel y tus propios usuarios en el chat, además de las claves, los proveedores de identidad y las salvaguardas que los conectan.
- Inicio de sesión y espacios de trabajoCómo iniciáis sesión tú y tu equipo en el panel de Syncanix, y cómo los espacios de trabajo mantienen el trabajo de cada cuenta bien separado.
- Autenticar a tus usuariosLas cuatro formas en que el widget puede autenticar a tus propios usuarios finales y cómo elegir la que encaja con tu stack.
- Conectar un proveedor de identidadConecta Auth0, Clerk, Amazon Cognito o WorkOS en el panel para que Syncanix pueda autenticar a tus usuarios finales a través del proveedor que ya usas.
- Claves de APICrea, revela y revoca los dos tipos de clave que emite Syncanix: una clave secreta para la CLI y el SDK, y una clave publicable para el widget integrado.
- Verificación adicional y seguridad de accionesCómo clasifica Syncanix cada acción como lectura, escritura o destructiva, y los controles de confirmación, reverificación y deshacer que protegen cada una.
SDKs
- SDKsLos SDK del lado del servidor que verifican las intenciones del agente de Syncanix en tu backend: uno por lenguaje, en ocho ecosistemas.
- PythonVerifica las intenciones del agente de Syncanix en Python —Django, Flask y FastAPI— con una comprobación HMAC local en cada llamada a herramienta.
- GoVerifica las intenciones del agente de Syncanix en Go —net/http, Gin, Echo y Fiber— con una comprobación HMAC local en cada llamada a herramienta.
- Spring BootVerifica las intenciones del agente de Syncanix en Spring Boot con verificación de intención autoconfigurada mediante un filtro de servlet.
- PHPVerifica las intenciones del agente de Syncanix en PHP —Laravel y Symfony— con una comprobación HMAC local en cada llamada a herramienta.
- RubyVerifica las intenciones del agente de Syncanix en Ruby —Rails y cualquier aplicación Rack— con una comprobación HMAC local en cada llamada a herramienta.
- RustVerifica las intenciones del agente de Syncanix en Rust —Axum, Actix Web y Tower— con una comprobación HMAC local en cada llamada a herramienta.
- .NETVerifica las intenciones del agente de Syncanix en ASP.NET Core 8+ —Minimal API y MVC— con una comprobación HMAC local en cada llamada a herramienta.
Facturación y planes
- Facturación y planesCómo cobra Syncanix: planes por espacio de trabajo, medición por unidades de cómputo (uso), suscripciones, el uso de tu propia clave de modelo y los límites que mantienen el consumo predecible.
- PlanesLos cinco planes de Syncanix —Dev, Starter, Growth, Scale y Enterprise— además de pruebas gratuitas, facturación anual y descuentos para organizaciones sin ánimo de lucro, educación y código abierto.
- Uso y mediciónCómo Syncanix mide el uso con unidades de cómputo (CU), cómo se cuentan, qué pasa al llegar al límite y dónde controlarlo.
- Gestionar tu suscripciónInicia, cambia o cancela un plan de Syncanix, gestiona tu método de pago a través del portal de facturación de Paddle y encuentra tus facturas y recibos.
- Usa tu propia clave (BYOK)Usa tu propia clave de Anthropic o OpenAI para que el proveedor facture el uso del modelo directamente, sin recargo de Syncanix. Las claves son de solo escritura y se cifran en reposo.
- Límites de tasa y topes de gastoLas salvaguardas que mantienen predecible el uso de Syncanix: límites de tasa de la plataforma que protegen la estabilidad y topes de gasto que configuras para no salirte del presupuesto.
Confianza, privacidad y cumplimiento
- Confianza, privacidad y cumplimientoCómo protege Syncanix tus datos y los de tus usuarios finales: residencia de datos en la UE, aislamiento entre inquilinos, qué procesamos y conservamos, tus derechos de privacidad, nuestro programa de cumplimiento y la transparencia de la IA.
- Seguridad en lenguaje sencilloUna respuesta en lenguaje sencillo a «¿están seguros mis datos con Syncanix?»: dónde residen, cómo se mantienen separados los clientes, quién puede verlos, qué ve la IA y qué controlas tú.
- Residencia de datos y seguridadSyncanix se ejecuta por completo en AWS eu-central-1 (Fráncfort), aísla los datos de cada cliente en cuatro capas y cifra los datos en tránsito y en reposo.
- Tratamiento y conservación de datosQué datos procesa Syncanix, cómo funciona la retención cero de datos (ZDR) con los proveedores de modelos, qué envía la CLI de descubrimiento y cuánto tiempo se conservan los datos.
- Privacidad y tus derechosCómo se controla la memoria del asistente, cómo se gestionan los datos personales y cómo tú y tus usuarios finales podéis ejercer los derechos del RGPD y la CCPA a través del formulario de solicitud de datos.
- Cumplimiento y subencargadosEl programa de cumplimiento de Syncanix: soporte de RGPD y CCPA con un DPA disponible, SOC 2 e ISO 27001 en curso, y los subencargados en los que nos apoyamos.
- Transparencia de la IACómo informa Syncanix del uso de IA a los usuarios finales en todos los idiomas, qué modelos impulsan al asistente y cómo se fundamentan las respuestas en tu contenido.
Guías
- GuíasTutoriales orientados a tareas que combinan la documentación de referencia en trabajos completos: lanzar el widget, conectar un cliente de IA, fundamentar respuestas, actuar por un usuario y pasar a producción.
- Añade el widget de chat a tu sitioPasa de tu código a un widget de chat en vivo: descubre tu API con la CLI, revisa el catálogo, diseña el widget e incrusta el fragmento.
- Conecta un cliente de IA a tu espacio de trabajoConecta Claude Desktop, Cursor o ChatGPT a tu servidor MCP de Syncanix para que un cliente de IA pueda usar tu API en tu nombre.
- Fundamenta las respuestas en tu contenidoAñade tu documentación y contenido para que el asistente responda desde tu material en lugar de adivinar, y comprueba que funciona.
- Fundamente el agente en su analíticaAporte al asistente el contexto de recorrido y comportamiento desde su propia analítica mediante MCP: ningún dato sale de sus herramientas.
- Deja que el asistente actúe por un usuario con sesión iniciadaPermite que el asistente realice acciones autenticadas en nombre de un usuario final con sesión iniciada, acotadas a sus permisos, con confirmación antes de las acciones sensibles.
- Mantén tu catálogo al díaReejecuta el descubrimiento cuando cambie tu API, intégralo en CI y deja que la detección de deriva en runtime capture lo que se escape.
- Exportación y borrado de datosCómo funcionan las solicitudes de los interesados con Syncanix: presentar solicitudes de acceso, exportación y borrado, los plazos de respuesta y quién hace qué.
- Cómo medimos el ROILa metodología transparente de resoluciones detrás de tu informe de ROI: qué cuenta como resolución y cómo se calcula el valor.
- Pasa a producciónLleva tu asistente de pruebas a producción: cambia al entorno de producción, genera claves de producción, define orígenes permitidos, elige un plan y activa las salvaguardas.
- Solución de problemasSoluciones partiendo del síntoma para los problemas que realmente vemos: un widget bloqueado, una primera petición lenta, fallos de detección, fallos de enriquecimiento y problemas de inicio de sesión.
Referencia
- ReferenciaUna consulta consolidada: datos rápidos, formatos de claves e identificadores, límites y valores por defecto de la plataforma, y enlaces a la referencia de la CLI, la referencia de MCP, el soporte de frameworks y el glosario.
- Claves, tokens e IDUna consulta consolidada de los formatos de credenciales e identificadores usados en Syncanix: claves de API secretas y publicables, tokens de conexión MCP y entornos.
- Límites y valores por defectoUna sola consulta para los hechos transversales de la plataforma: región de datos, conservación de registros, respuestas de límite de tasa, la unidad de medición, topes de gasto y los idiomas admitidos.
- Referencia de la API en tiempo de ejecuciónLos contratos del lado del cliente en runtime: la cabecera de intención firmada que verifica tu backend, el contrato actuar-como-usuario que observa, y la forma de los datos del witness.