# Zylon

> Zylon is an enterprise AI platform delivering private generative AI and on-premise AI software for regulated industries, enabling secure deployment inside enterprise infrastructure without external cloud dependencies.

## Home

- [Welcome to Zylon](https://docs.zylon.ai/en/index.md): Zylon is an enterprise AI platform delivering private generative AI and on-premise AI software for regulated industries, enabling secure deployment inside enterprise infrastructure without external cloud dependencies.

## User Manual

### About Zylon Workspace

- [What is Zylon Workspace?](https://docs.zylon.ai/en/user-manual/what-is-zylon-workspace.md): Learn about Zylon's collaborative AI workspace and how it transforms company knowledge into productivity
- [First Day FAQs](https://docs.zylon.ai/en/user-manual/first-day-faqs.md): Quick answers to common questions when starting with Zylon Workspace
- [Quick Start Guide](https://docs.zylon.ai/en/user-manual/quick-start-guide.md): Get productive with Zylon Workspace in 15 minutes

### Admin Tools

- [Workspace Look & Feel](https://docs.zylon.ai/en/user-manual/workspace-look-and-feel.md): Customize Zylon Workspace branding and appearance for your organization
- [Adding Company Context](https://docs.zylon.ai/en/user-manual/adding-company-context.md): Manage the organization-level context in the admin area.
- [Block Resource Downloads](https://docs.zylon.ai/en/user-manual/block-resource-downloads.md): Control whether users can download uploaded Knowledge Base files and AI-generated resources.
- [Engagement Analytics](https://docs.zylon.ai/en/user-manual/engagement-analytics.md): Admin‑only, aggregated view (usage dashboard) to understand adoption over time.
- [Managing Organization Skills](https://docs.zylon.ai/en/user-manual/managing-organization-skills.md): Admin-only. Build a shared library of Skills that any project in your organization can use.

### Projects

- [Creating a project](https://docs.zylon.ai/en/user-manual/creating-a-project.md): Create a new project and understand where it lives by default.
- [Adding custom instructions](https://docs.zylon.ai/en/user-manual/adding-custom-instructions.md): Provide project-specific instructions used in every chat in the project.
- [Sharing with colleagues](https://docs.zylon.ai/en/user-manual/sharing-with-colleagues.md): Share a project with everyone in the organization or invite specific teammates to collaborate.

### Knowledge Bases

- [Uploading files](https://docs.zylon.ai/en/user-manual/uploading-files.md): Add knowledge to a project by uploading local files or importing from a connector.
- [Roles and permissions](https://docs.zylon.ai/en/user-manual/roles-and-permissions.md): Access to the knowledge base is controlled by the project roles.
- [Linking knowledge bases](https://docs.zylon.ai/en/user-manual/linking-knowledge-bases.md): Reuse content from other projects without re‑ingesting.

#### External Connectors

- [Google Drive connector](https://docs.zylon.ai/en/user-manual/connectors/google-drive.md): Import Google Drive files and folders into a project knowledge base.
- [SharePoint connector](https://docs.zylon.ai/en/user-manual/connectors/sharepoint.md): Import folders and files from SharePoint and keep them in sync on demand.
- [Confluence connector](https://docs.zylon.ai/en/user-manual/connectors/confluence.md): Import folders and files from Confluence and keep them in sync on demand.
- [Confluence Server connector](https://docs.zylon.ai/en/user-manual/connectors/confluence-server.md): Import pages from an on-premise Confluence Server / Data Center instance and keep them in sync on demand.
- [File System Connector](https://docs.zylon.ai/en/user-manual/connectors/file-system.md): Import folders and files from an SMB server and keep them in sync on demand.
- [Claromentis connector](https://docs.zylon.ai/en/user-manual/connectors/claromentis.md): Import folders and files from Claromentis and keep them in sync on demand.

### Skills

- [Introduction to Skills](https://docs.zylon.ai/en/user-manual/skills/introduction-to-skills.md): What a Skill is, and when to use one instead of just asking in chat.
- [Creating a Skill](https://docs.zylon.ai/en/user-manual/skills/creating-a-skill.md): Add a new Skill to your project by uploading a Skill file.
- [Installing an organization Skill](https://docs.zylon.ai/en/user-manual/skills/installing-from-organization.md): Reuse a Skill your admin already published, without building it yourself.
- [Using a Skill in chat](https://docs.zylon.ai/en/user-manual/skills/using-skills-in-chat.md): Apply a Skill to a conversation, or have it turn on automatically.

### Search

- [Search workspace content](https://docs.zylon.ai/en/user-manual/search-workspace-content.md): Find projects, chats, AI Documents, and files you have access to using Search.
- [Search company documents](https://docs.zylon.ai/en/user-manual/search-company-documents.md): Use Search to discover documents imported from company repositories you can access.

### Chat Assistant

- [When to use the chat assistant](https://docs.zylon.ai/en/user-manual/when-to-use-chat-assistant.md): Ask direct questions or use it as a thought partner for open-ended tasks.
- [Querying company documents](https://docs.zylon.ai/en/user-manual/querying-company-documents.md): Ask questions over your project’s knowledge base, including connected repositories.
- [Group chats](https://docs.zylon.ai/en/user-manual/group-chats.md): Start collaborative chats in a project and convert private chats when needed.

#### Using Tools

- [Using tools — overview](https://docs.zylon.ai/en/user-manual/tools/introduction-to-tools.md): Tools extend the chat agent for deeper reasoning and data analysis.
- [Extended thinking](https://docs.zylon.ai/en/user-manual/tools/extended-thinking.md): Enable deeper, step‑by‑step reasoning for richer answers.
- [Numeric analysis](https://docs.zylon.ai/en/user-manual/tools/numeric-analysis.md): Analyze a CSV from your knowledge base with natural‑language queries.
- [Database connector](https://docs.zylon.ai/en/user-manual/tools/database-connector.md)
- [Mcp connector](https://docs.zylon.ai/en/user-manual/tools/mcp-connector.md)
- [Attach files in chat](https://docs.zylon.ai/en/user-manual/tools/attachments.md): Drop images and documents straight into a chat message so Zylon can read and use them.
- [Web search](https://docs.zylon.ai/en/user-manual/tools/web-search.md): Browse the internet to find up-to-date information.

### AI Documents

- [When to use AI Documents](https://docs.zylon.ai/en/user-manual/when-to-use-agent-flows.md): Use AI Documents for comprehensive document work that goes beyond quick chat answers.
- [Real‑time collaboration](https://docs.zylon.ai/en/user-manual/real-time-collaboration.md): Co‑edit AI Document outputs with teammates.
- [Inline AI in the editor](https://docs.zylon.ai/en/user-manual/inline-ai-in-editor.md): Use AI on selections to improve or generate content, optionally grounded in your knowledge base.

#### Available AI Documents

- [Summarize file](https://docs.zylon.ai/en/user-manual/agent-flows/summarize-file.md): Produce a comprehensive summary of long documents or folders.
- [Answer in bulk](https://docs.zylon.ai/en/user-manual/agent-flows/answer-in-bulk.md): Ask many questions at once and get a table of answers with citations.
- [Generate draft](https://docs.zylon.ai/en/user-manual/agent-flows/generate-draft.md): Create a new document that follows the tone and content of selected sources.
- [Open blank page](https://docs.zylon.ai/en/user-manual/agent-flows/open-blank-page.md): Start from scratch and optionally use AI to help you write.
- [Read and extract](https://docs.zylon.ai/en/user-manual/agent-flows/read-and-extract.md): Define topics and extract all relevant passages across long documents, with citations.

### Profile

- [Password recovery](https://docs.zylon.ai/en/user-manual/password-recovery.md): Change your password or reset it in case you have forgotten it

### n8n

- [First steps in n8n](https://docs.zylon.ai/en/user-manual/n8n.md)

### Security

- [Authentication for Sensitive Actions](https://docs.zylon.ai/en/user-manual/security/authentication-for-sensitive-actions.md): Understand when Zylon asks you to authenticate again before performing a sensitive action.

## Developer Manual

### First Steps

- [Intro to Zylon](https://docs.zylon.ai/en/developer-manual/get-started/intro-to-zylon.md): Self‑hosted AI platform with Anthropic‑compatible Messages endpoints and a Workspace API.
- [Token Management](https://docs.zylon.ai/en/developer-manual/get-started/token-management.md): Choose the right token flow: Backoffice cross-API token or Workspace-only token.
- [Quickstart](https://docs.zylon.ai/en/developer-manual/get-started/quickstart.md): Make your first Zylon API call in under 2 minutes.
- [Developer Console](https://docs.zylon.ai/en/developer-manual/get-started/developer-console.md): API token management for developers.

### Build with Zylon

#### ZylonGPT API

- [Overview](https://docs.zylon.ai/en/developer-manual/build-with-zylon/zylon-gpt-api/overview.md): The ZylonGPT API lets you generate responses, ingest knowledge, create embeddings, and call tools in one flow.
- [Messages](https://docs.zylon.ai/en/developer-manual/build-with-zylon/working-with-messages.md): Message requests with sync, streaming, and async patterns.
- [Artifacts](https://docs.zylon.ai/en/developer-manual/build-with-zylon/working-with-artifacts.md): Create and ingest ZylonGPT artifacts for retrieval and context.
- [Embeddings](https://docs.zylon.ai/en/developer-manual/build-with-zylon/zylon-gpt-api/embeddings.md): Generate embeddings for semantic search and similarity.
- [Handling stop reasons](https://docs.zylon.ai/en/developer-manual/build-with-zylon/zylon-gpt-api/handling-stop-reasons.md): Know why a response stopped and how to handle ZylonGPT errors.

##### Tools

- [Overview](https://docs.zylon.ai/en/developer-manual/build-with-zylon/tools/introduction-to-tools.md): Enable built-in and custom tools in Messages.

###### Built-in

- [Semantic Search tool](https://docs.zylon.ai/en/developer-manual/build-with-zylon/tools/built-in/semantic-search-tool.md): Search your ingested artifacts for relevant chunks during a message.
- [Tabular Analysis tool](https://docs.zylon.ai/en/developer-manual/build-with-zylon/tools/built-in/tabular-analysis-tool.md): Analyze ingested tabular artifacts during a message.
- [Web Fetch tool](https://docs.zylon.ai/en/developer-manual/build-with-zylon/tools/built-in/web-fetch-tool.md): Fetch and extract a URL mentioned in the message.
- [Web Search tool](https://docs.zylon.ai/en/developer-manual/build-with-zylon/tools/built-in/web-search-tool.md): Search the web from a natural language query.
- [Database Query tool](https://docs.zylon.ai/en/developer-manual/build-with-zylon/tools/built-in/database-query-tool.md): Query a SQL database from natural language.

###### Custom

- [Custom tools](https://docs.zylon.ai/en/developer-manual/build-with-zylon/tools/custom/custom-tools.md): Define your own tools using JSON Schema.

#### Workspace API

- [Overview](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/overview.md): API for automating and managing Zylon Workspace.

##### General

- [Overview](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/general/overview.md): Monitoring, reporting, and system endpoints for Workspace API.
- [Analytics](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/general/analytics.md): Track usage totals, rankings, and time series metrics.
- [Issues](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/general/issues.md): Create and manage user-reported issues.
- [Search](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/general/search.md): Search across projects, threads, artifacts, artifact content, and interactions.
- [System](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/general/system.md): Health checks for workspace availability.

##### Authentication

- [OpenID & OAuth](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/authentication/openid.md): Start SSO logins and integration OAuth flows for Confluence and SharePoint.
- [Auth](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/authentication/auth.md): Log in and end sessions for Workspace API access.

##### Users

- [Users](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/users/user.md): Create and manage users, roles, and project access.
- [Organizations](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/users/user-organization.md): Read and update the current Workspace organization.

##### Projects

- [Projects](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/projects/project.md): Create projects, update metadata, and run project-scoped chat.
- [Project Members](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/projects/project-member.md): Add, update, and remove members from a project.

##### Content

- [Artifacts](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/content/artifacts.md): Workspace artifacts for documents, AI Documents, and connectors.

###### Integrations

- [Confluence Integration](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/integrations/confluence.md): Read and sync Confluence content into projects.
- [Filesystem Integration](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/integrations/filesystem.md): Sync files from a shared filesystem into your workspace.
- [SharePoint Integration](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/integrations/sharepoint.md): Sync SharePoint documents into your workspace.
- [Claromentis Integration](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/integrations/claromentis.md): Sync Claromentis content into your workspace.

##### Chats

- [Chats](https://docs.zylon.ai/en/developer-manual/build-with-zylon/workspace-api/chats/threads.md): Threads, interactions, and one-shot chat endpoints.

#### Backoffice API

- [Overview](https://docs.zylon.ai/en/developer-manual/build-with-zylon/backoffice-api/overview.md): Backoffice API endpoints for operational and platform-level workflows.
- [Logging](https://docs.zylon.ai/en/developer-manual/build-with-zylon/backoffice-api/logging.md): Retrieve Zylon platform logs manually from the Backoffice API.

### Coding Agents

- [Opencode](https://docs.zylon.ai/en/developer-manual/get-started/opencode-setup.md): Install and configure Opencode CLI to work with Zylon's AI platform.
- [Claude Code](https://docs.zylon.ai/en/developer-manual/get-started/claude-code-setup.md): Configure Claude Code CLI to work with Zylon's AI platform.

## Operator Manual

### Getting Started

- [How to use this manual](https://docs.zylon.ai/en/operator-manual/index.md)

### Installation

- [Getting Started](https://docs.zylon.ai/en/operator-manual/installation/index.md): Choose your installation mode based on your security and connectivity needs
- [Hardware requirements](https://docs.zylon.ai/en/operator-manual/installation/hardware-requirements.md)
- [Online Installation](https://docs.zylon.ai/en/operator-manual/installation/online.md): Install Zylon with full internet access
- [Semi-Airgap Installation](https://docs.zylon.ai/en/operator-manual/installation/semi-airgap.md): Install Zylon in environments with restricted internet access
- [Full-Airgap Installation](https://docs.zylon.ai/en/operator-manual/installation/airgap.md): Install Zylon in completely offline environments
- [Install Zylon (Legacy)](https://docs.zylon.ai/en/operator-manual/installation/legacy.md): A guide to install Zylon on a single instance
- [Uninstall](https://docs.zylon.ai/en/operator-manual/installation/uninstall.md)

### Maintenance & Operations

- [Backups and Disaster Recovery](https://docs.zylon.ai/en/operator-manual/operations/backup.md)
- [Store Zylon Data on a Separate Disk](https://docs.zylon.ai/en/operator-manual/operations/data-disk.md): Move Zylon's data directory to a dedicated disk or partition for additional storage capacity.
- [Sys Admin Dashboard](https://docs.zylon.ai/en/operator-manual/operations/sys-admin-dashboard.md): Monitor and manage system health, performance, and user activities with the Sys Admin Dashboard.

### Backoffice

- [Introduction](https://docs.zylon.ai/en/operator-manual/backoffice/introduction.md): Overview of the Zylon Backoffice.
- [Roles and Permissions](https://docs.zylon.ai/en/operator-manual/backoffice/roles-and-permissions.md): Backoffice roles, access levels, and responsibilities.
- [Accessing the Backoffice](https://docs.zylon.ai/en/operator-manual/backoffice/accessing-the-backoffice.md): Open the Backoffice from a Workspace or a direct URL.
- [Platform Backoffice](https://docs.zylon.ai/en/operator-manual/backoffice/platform-backoffice.md): Operator controls for accounts, roles, gateways, and service status.
- [Guardrails](https://docs.zylon.ai/en/operator-manual/backoffice/guardrails.md): Create regex-based guardrails and assign them to gateways to block AI requests that match sensitive patterns.
- [Usage Dashboard](https://docs.zylon.ai/en/operator-manual/backoffice/usage-dashboard.md): Monitor AI usage across gateways, API tokens, and Workspace activity.

### Configuration

- [Configuration Overview](https://docs.zylon.ai/en/operator-manual/configuration/index.md): Complete guide to configuring your Zylon instance
- [Zylon CLI](https://docs.zylon.ai/en/operator-manual/configuration/cli.md): All the commands available in the CLI

#### AI Presets

- [Getting Started](https://docs.zylon.ai/en/operator-manual/ai-presets/getting-started.md): Learn the fundamentals of AI presets and how to configure them for your hardware
- [AI Presets Reference](https://docs.zylon.ai/en/operator-manual/ai-presets/presets.md): Complete reference of available AI presets including base, alternative, experimental, and deprecated configurations
- [Configuration Options](https://docs.zylon.ai/en/operator-manual/ai-presets/configuration.md): Configure enhanced capabilities, multi-GPU setups, and shared memory for optimal performance
- [Advanced Customization](https://docs.zylon.ai/en/operator-manual/ai-presets/advanced-customization.md): Customize AI models for specialized workloads including fine-tuned models and multi-model configurations
- [Troubleshooting](https://docs.zylon.ai/en/operator-manual/ai-presets/troubleshooting.md): Diagnose and resolve issues with AI presets and custom configurations

#### Network & Connectivity

- [Ports and DNS](https://docs.zylon.ai/en/operator-manual/configuration/network/ports-and-dns.md)
- [Proxy](https://docs.zylon.ai/en/operator-manual/configuration/network/proxy.md)

#### Authentication

- [Google Integration (SSO)](https://docs.zylon.ai/en/operator-manual/openid/google.md)
- [Microsoft Entra Integration (SSO)](https://docs.zylon.ai/en/operator-manual/openid/microsoft.md)
- [LDAP Directory Authentication](https://docs.zylon.ai/en/operator-manual/authentication/ldap.md): Configure Zylon to authenticate users against an LDAP directory or Active Directory, enabling centralized login without an external identity provider.

#### Knowledge Base Connectors

- [Knowledge Connectors](https://docs.zylon.ai/en/operator-manual/knowledge-base/index.md)
- [Google Drive](https://docs.zylon.ai/en/operator-manual/knowledge-base/google-drive.md)
- [SharePoint](https://docs.zylon.ai/en/operator-manual/knowledge-base/sharepoint.md)
- [Confluence](https://docs.zylon.ai/en/operator-manual/knowledge-base/confluence.md)
- [Confluence Server](https://docs.zylon.ai/en/operator-manual/knowledge-base/confluence-server.md)
- [Samba File System](https://docs.zylon.ai/en/operator-manual/knowledge-base/file-system.md)
- [Claromentis](https://docs.zylon.ai/en/operator-manual/knowledge-base/claromentis.md)

#### Features & Capabilities

- [MCP Tool Connector](https://docs.zylon.ai/en/operator-manual/configuration/features/feat-mcp.md)
- [Vision File Processing](https://docs.zylon.ai/en/operator-manual/configuration/features/feat-file-vision.md)
- [Database Tool Connector](https://docs.zylon.ai/en/operator-manual/configuration/features/feat-database.md)
- [Audit Log](https://docs.zylon.ai/en/operator-manual/configuration/features/feat-audit.md)
- [Log Delivery and Storage](https://docs.zylon.ai/en/operator-manual/configuration/features/log-delivery-storage.md): Configure Zylon log storage, syslog delivery, and HTTP delivery.
- [Project Custom Instructions](https://docs.zylon.ai/en/operator-manual/configuration/features/feat-project-custom-instructions.md)
- [Web Extract](https://docs.zylon.ai/en/operator-manual/configuration/features/feat-webextract.md)
- [Web Search](https://docs.zylon.ai/en/operator-manual/configuration/features/feat-websearch.md)
- [Multimodalility capabilities](https://docs.zylon.ai/en/operator-manual/configuration/features/feat-multimodal.md)
- [Authentication Freshness](https://docs.zylon.ai/en/operator-manual/configuration/features/authentication-freshness.md): Configure authentication freshness for sensitive workspace and backoffice actions.

#### Cron Tasks

- [Sync](https://docs.zylon.ai/en/operator-manual/configuration/cron-tasks/sync.md): Configure the scheduled integration sync task
- [Hard delete](https://docs.zylon.ai/en/operator-manual/configuration/cron-tasks/hard-delete.md): Configure the retention policy used by the workspace cleanup task

#### Advanced Settings

- [Search](https://docs.zylon.ai/en/operator-manual/configuration/search.md)
- [Performance tweaks](https://docs.zylon.ai/en/operator-manual/configuration/performance.md)
- [Whitelabel](https://docs.zylon.ai/en/operator-manual/configuration/whitelabel.md)
- [n8n](https://docs.zylon.ai/en/operator-manual/configuration/n8n.md)

##### Observability

- [How to configure observability](https://docs.zylon.ai/en/operator-manual/configuration/observability/index.md)
- [Platform Metrics](https://docs.zylon.ai/en/operator-manual/configuration/observability/platform-metrics.md)
- [Metrics Destinations](https://docs.zylon.ai/en/operator-manual/configuration/observability/destinations.md)
- [External Grafana Dashboard](https://docs.zylon.ai/en/operator-manual/configuration/observability/external-grafana-dashboard.md)

### Troubleshooting

- [General issues](https://docs.zylon.ai/en/operator-manual/troubleshooting/troubleshoot.md)
- [Exporting Logs](https://docs.zylon.ai/en/operator-manual/troubleshooting/exporting-logs.md)
- [Nvidia Drivers](https://docs.zylon.ai/en/operator-manual/troubleshooting/nvidia-drivers.md)
- [AI Inference Performance](https://docs.zylon.ai/en/operator-manual/troubleshooting/ai.md): Troubleshooting guide for diagnosing and improving AI inference performance in Zylon.

### Security

- [Security overview](https://docs.zylon.ai/en/operator-manual/instance-hardening/index.md): Guides for securing and hardening your Zylon server against unauthorized access and network exposure
- [Airgap Your Server](https://docs.zylon.ai/en/operator-manual/instance-hardening/airgap-your-server.md)
- [Disk Encryption](https://docs.zylon.ai/en/operator-manual/instance-hardening/disk-encryption.md): Encrypt your Zylon server's disk to protect data at rest on Ubuntu 24.04
- [Authentication for Sensitive Actions](https://docs.zylon.ai/en/operator-manual/security/authentication-for-sensitive-actions.md): Compliance reference for actions protected by authentication freshness.

### Auditability & AI Governance

- [Auditability & AI Governance](https://docs.zylon.ai/en/operator-manual/auditability-ai-safety/index.md): Auditability, traceability, evidence preservation, governance, and AI accountability capabilities in Zylon.
- [Logging, Evidence, and SIEM Delivery](https://docs.zylon.ai/en/operator-manual/backoffice/log-delivery-storage.md): Governance guide to Zylon logging, evidence preservation, auditability, traceability, and SIEM delivery.

## Customer Support Manual

- [Zendesk User Manual – Clients](https://docs.zylon.ai/en/customer-support-manual/zendesk-client-manual.md): How to submit, track, and manage support requests through the Zylon Help Center.

## Changelog

- [Changelog](https://docs.zylon.ai/en/changelog/index.md)

## OpenAPI Specs

- [pgpt](/api-reference/pgpt.json)
- [workspace](/api-reference/workspace.json)
- [pgpt](/en/api-reference/pgpt.json)
- [workspace](/en/api-reference/workspace.json)
- [pgpt](/es/api-reference/pgpt.json)
- [workspace](/es/api-reference/workspace.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Spanish (151 pages)](https://docs.zylon.ai/_llms/es.md): Documentation for Spanish.