Resources
Documentation
Complete portal guide and sitemap for all Asiyst developer documentation, guides, and API references.
Overview
Welcome to the central Asiyst Documentation Portal. Whether you are embedding an interactive 3D assistant on an e-commerce storefront, building a RAG knowledge base for technical SaaS documentation, or automating CI/CD deployments via the CLI, these guides cover every step of the integration journey.
Documentation Tracks & Learning Paths
The documentation is organized into focused functional tracks:
| Track | Target Audience | Primary Focus |
|---|---|---|
| Getting Started | New Developers & Builders | Account creation, project setup, and verified installation |
| Core Concepts | Software Architects | RAG architecture, session lifetimes, and vector isolation |
| Web SDK | Frontend Engineers | React, Next.js App Router, Vue, and vanilla DOM integration |
| CLI | DevOps & Full-Stack Engineers | Local automation, GitHub Actions CI/CD, and knowledge syncing |
| API | Backend Engineers | REST endpoints, webhook listeners, and server-side provisioning |
| Knowledge Base | Content & Ops Teams | Document ingestion, sitemap crawlers, and vector chunking |
| Avatar Studio | Designers & Product Managers | 3D model rigging, lighting presets, and animation states |
| Analytics & Security | Security & Data Teams | Telemetry tracking, conversion funnels, and GDPR compliance |
Quick Start Guides
- Quickstart Guide: From empty repo to live assistant in 5 minutes.
- Web SDK Installation: Package managers, script tags, and framework adapters.
- Connect Your Website: Domain whitelisting and handshake verification.
SDK & API References
- SDK Reference: Complete method signatures, options interfaces, and event listeners.
- API Reference: REST endpoint definitions, HTTP headers, and status codes.
- CLI Command Reference: Command syntax, flags, and JSON output pipelines.
Community & Support Resources
- Official GitHub Organization: Star repositories, open issues, and inspect sample projects.
- Developer Discord Community: Real-time chat with core platform engineers.
- Support Portal: Open enterprise tickets with dedicated SLAs.