Skip to main content
Próxima versión — Zylon 1.58Esta documentación se publica antes del lanzamiento para que puedas preparar tus integraciones de API. La imagen de la versión todavía no está disponible. Para instalaciones con 1.57, consulta la documentación de 1.57.
La Workspace API te permite gestionar por API todo lo que ocurre en Zylon Workspace: organizaciones, miembros del espacio de trabajo, proyectos, chats, artefactos, integraciones e informes. Úsala para automatizar tareas de administración o integrar Zylon con tus sistemas internos.

​
Actualizar a 1.58

Consulta la guía de migración 1.57 → 1.58 para las rutas antiguas conservadas, cuerpos de artefactos y cambios de chat/hilos. Si tu integración usa IDs de usuario o cuenta, migra los mapeos y comparaciones afectados: los IDs de creador ahora identifican cuentas, mientras que las APIs de membresía siguen usando IDs de miembro. Que una petición funcione no garantiza que los IDs almacenados sigan coincidiendo. Para integraciones que necesiten identidad de usuario o filtros de creador, usa la API actual y sigue la búsqueda de ID de cuenta a partir del ID de miembro; las URLs antiguas conservadas no hacen esa conversión.

​
Base URL

Todos los endpoints de Workspace viven bajo:

​
Cabecera de organización (x-org)

Los endpoints de Workspace bajo /api/v1/app/* requieren la cabecera x-org para que Zylon sepa a qué organización del workspace apuntar. Puedes enviar x-org como:
  • el slug de la organización (recomendado), por ejemplo default
  • el ID de la organización (UUID)
Úsalo así en tus solicitudes:

​
Scopes de token de solo lectura

Workspace.Read.All permite lecturas y búsquedas de Workspace, incluidas organizaciones, miembros del espacio de trabajo, proyectos, artefactos, hilos, interacciones, incidencias, feedback e integraciones. No permite mutaciones de Workspace; las operaciones de creación, actualización, eliminación, unión y otras escrituras devuelven 403. Read.All incluye los mismos permisos de lectura/búsqueda de Workspace y también inventario de cuentas, tokens y gateways y lecturas de Backoffice/metadatos. Su allowlist de solo lectura de ZylonGPT solo se puede usar cuando el token de cuenta incluye gateway_id; un token Read.All creado sin contexto de gateway no puede llamar a ZylonGPT. El acceso efectivo siempre queda limitado por los permisos de rol del propietario del token. Los scopes múltiples combinan sus permisos. Consulta Gestión de tokens para ver los seis scopes y las reglas de creación.

​
Conceptos clave

Este modelo permite escenarios multi‑organización en los que una misma persona puede pertenecer a varios espacios de trabajo con roles distintos.

​
Paginación

La paginación es un modelo compartido en la Workspace API. Los listados devuelven un sobre con cursores:
Usa page, page_size, after, before, first, last y total_count cuando estén disponibles.

​
Secciones de Workspace API

General

Analíticas, incidencias, búsqueda y estado del sistema.

Autenticación

Flujos SSO y callbacks de login/autenticación de workspace.

Miembros del espacio de trabajo

Crea, actualiza y gestiona el acceso de miembros del espacio de trabajo y su pertenencia a organizaciones.

Proyectos

Aprovisiona proyectos, gestiona miembros y controla la visibilidad.

Chats

Crea hilos, ejecuta interacciones y transmite respuestas en streaming.

Contenido

Gestiona artefactos e integraciones como Confluence, SharePoint, Filesystem y Claromentis.

​
Errores y casos límite

  • 401/403: token ausente o permisos insuficientes.
  • 404: IDs inválidos o eliminados.
  • Redirecciones: login/callback devuelven 302 para navegadores.