Skip to Content
ZyAgent

ZyAgent Documentation

ZyAgent is a framework for building and operating agent systems. It gives you a runtime harness for composing agents with memory, tools, skills, sandboxes, and subagents, and it also provides an application layer that turns those capabilities into a usable product experience.

This documentation is organized around those two parts:

  • ZyAgent Harness: the core SDK and runtime layer for building your own agent system.
  • ZyAgent App: a reference application built on top of the Harness for deployment, operations, and end-user workflows.

If you want to understand how ZyAgent works, start with the Introduction. If you want to build on the core runtime, go to the Harness docs. If you want to deploy and use ZyAgent as an application, go to the App docs.

Start here

If you are new to ZyAgent

Start with the conceptual overview first.

If you want to build with ZyAgent

Start with the Harness section. This path is for teams who want to integrate ZyAgent capabilities into their own system or build a custom agent product on top of the ZyAgent runtime.

If you want to deploy and use ZyAgent

Start with the App section. This path is for teams who want to run ZyAgent as a complete application and understand how to configure, operate, and use it in practice.

Documentation structure

Introduction

The Introduction section helps you build the right mental model before you look at implementation details.

  • What is ZyAgent explains what ZyAgent is and what problems it is designed to solve.
  • Why ZyAgent explains the motivation behind the project.
  • Core Concepts introduces the concepts that appear across the documentation.
  • Harness vs App explains the relationship between the runtime layer and the application layer.

ZyAgent Harness

The Harness section is the core of the technical documentation. It is written for developers who want to build their own ZyAgent-based system.

  • Quick Start shows how to create your first harness with the core ZyAgent API.
  • Design Principles explains the architectural ideas behind the Harness.
  • Configuration covers the main configuration surface of the SDK/runtime.
  • Memory, Tools, Skills, and Sandbox explain the major system capabilities separately.
  • Customization shows how to adapt ZyAgent to your own product requirements.
  • Integration Guide explains how to integrate the Harness into a larger system.

ZyAgent App

The App section is written for teams who want to deploy ZyAgent as a usable product.

  • Quick Start helps you run the application locally.
  • Deployment Guide explains how to deploy ZyAgent in your own environment.
  • Configuration covers the application-level configuration model.
  • Workspace Usage explains the main user workflows.
  • Agents and Threads explains how users interact with ZyAgent in practice.
  • Operations and Troubleshooting covers maintenance and production usage.

Tutorials

The Tutorials section is for hands-on, task-oriented learning.

Reference

The Reference section is for detailed lookup material, including configuration, runtime modes, APIs, and source-oriented mapping.

Choose the right path

  • If you are evaluating the project, start with Introduction.
  • If you are building your own agent system, start with ZyAgent Harness.
  • If you are deploying ZyAgent for users, start with ZyAgent App.
  • If you want to learn by doing, go to Tutorials.
Introduction