Visión general

La Workspace API te permite gestionar por API todo lo que ocurre en Zylon Workspace: organizaciones, usuarios, proyectos, chats, artefactos, integraciones e informes. Úsala para automatizar tareas de administración o integrar Zylon con tus sistemas internos.

Base URL

Todos los endpoints de Workspace viven bajo:

https://{BASE_URL}/api/v1

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:

-H "x-org: {org_slug}"

Conceptos clave

Concepto	Significado
Cuenta (`Account`)	Registro de identidad que se autentica en Zylon. Una cuenta puede pertenecer a varias organizaciones.
Usuario (`User`)	Representación de una cuenta dentro de una organización. Una cuenta puede tener varios usuarios, uno por organización.
Artefacto (`Artifact`)	Contenido persistente que puede reutilizarse en chats y herramientas.

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:

Ejemplo de sobre de paginación

{
  "data": [],
  "next_cursor": "cursor_next",
  "previous_cursor": "cursor_prev",
  "has_next_page": false,
  "has_previous_page": false,
  "total_count": 0
}

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.

Usuarios

Crea, actualiza y gestiona usuarios 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.

​Base URL

​Cabecera de organización (x-org)

​Conceptos clave

​Paginación

​Secciones de Workspace API