Official documentation for Xagent - The Agent Operating System.
Xagent is an AI agent platform that enables you to describe goals and let agents figure out how to accomplish them. No workflow engineering required.
- Quick Start - Get started in minutes
- Installation - Deployment and setup guide
- API Reference - Complete API documentation
Install the Mintlify CLI to preview documentation changes locally:
npm i -g mintRun the following command at the root of the documentation:
mint devView your local preview at http://localhost:3000.
API documentation is auto-generated from OpenAPI specification. To update:
# Fetch latest OpenAPI spec from running Xagent instance
curl http://localhost:8000/openapi.json > api-reference/openapi.json
# Regenerate API docs (if needed)
npx @mintlify/scraping@latest openapi-file ./api-reference/openapi.json -o api-referenceInstall the Mintlify GitHub app from your dashboard to deploy changes automatically. Changes are deployed to production after pushing to the default branch.
xagent-docs/
├── api-reference/ # Auto-generated API documentation
├── agents/ # Agent documentation
├── deployment/ # Deployment and configuration
├── files/ # File management
├── guides/ # User guides
├── images/ # Documentation images
├── knowledge/ # Knowledge base docs
├── memory/ # Memory system docs
├── models/ # Model documentation
├── monitoring/ # Monitoring and observability
├── tasks/ # Task execution docs
├── templates/ # Template documentation
├── tools/ # Tool documentation
├── docs.json # Navigation configuration
└── package.json # Dependencies
This documentation is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).