Overview - Zylon

The Workspace API lets you programmatically manage everything in Zylon Workspace—organizations, users, projects, chats, artifacts, integrations, and reporting. Use it to automate admin workflows or integrate Zylon into your internal systems.

Base URL

All Workspace endpoints live under:

https://{BASE_URL}/api/v1

Organization header (`x-org`)

Workspace endpoints under /api/v1/app/* require the x-org header so Zylon knows which workspace organization to target. You can set x-org to either:

the organization slug (recommended), for example default
the organization ID (UUID)

Use this in requests:

-H "x-org: {org_slug}"

Core concepts

Concept	Meaning
Account	The identity record that authenticates into Zylon. One account can belong to multiple organizations.
User	The org-specific representation of an account. An account can have multiple users, one per organization.
Artifact	A persisted piece of knowledge that can be retrieved in chats and tools.

This model supports multi‑org setups where the same person can be a member of multiple workspaces with different roles.

Pagination

Pagination is a shared model across the Workspace API. List endpoints return a page envelope with cursors:

Pagination envelope example

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

Use page, page_size, after, before, first, last, and total_count when they’re available on the endpoint.

Workspace API sections

General

Analytics, issues, search, and system status endpoints.

Authentication

SSO login flows and workspace login/auth callbacks.

Users

Create, update, and manage user access and org membership.

Projects

Provision projects, manage membership, and control visibility.

Chats

Create threads, run interactions, and stream responses.

Content

Manage artifacts and integrations like Confluence, SharePoint, Filesystem, and Claromentis.

For manual log retrieval, use Backoffice API: Logging.

Errors and edge cases

401/403: token missing or insufficient permissions.
404: resource IDs are invalid or deleted.
Redirect endpoints: login/callback routes return 302 responses intended for browsers.

​Base URL

​Organization header (x-org)

​Core concepts

​Pagination

​Workspace API sections