Knowledge Base
Sources
Connect websites, uploaded documents, GitHub repositories, and URL lists into searchable knowledge bases.
Overview
A Source represents an external origin of truth connected to your Asiyst project. Once connected, the source is continuously monitored or re-crawled according to your update schedule.
Supported Source Types
| Source Type | Best For | Ingestion Method | Auto-Sync |
|---|---|---|---|
| Website | Marketing websites, knowledge bases, sitemaps | Automated crawler (respects robots.txt) | Daily / Weekly |
| Documents | Product PDFs, user manuals, internal SOPs | Drag-and-drop or multipart API upload | Manual / CI/CD |
| GitHub | Developer docs, open source code, READMEs | GitHub App webhook integration | On git push |
| URL List | Specific pricing pages, legal terms, blogs | Explicit URL list batch fetch | Scheduled |
Adding Sources via Dashboard
- Navigate to Project > Knowledge > Sources in the Asiyst Dashboard.
- Click + Add Source and choose the source category.
- Configure source properties:
- Source Name: A descriptive label (e.g.,
Acme API Reference 2026).- Target / Files: Enter your seed URL, upload files, or link your GitHub repository.
- Collection: Assign to an existing collection or create a new one.
- Click Start Ingestion. The engine will queue the source for parsing and embedding.
Managing Sources via CLI
Sync your local documentation directory directly from your terminal:
# Sync local markdown docs to project knowledge base
asiyst knowledge sync ./docs --project proj_9f8a2b3c4d
# Ingest a remote website sitemap
asiyst knowledge add-source --type website --url "https://docs.mycompany.com/sitemap.xml"
Source Synchronization Status
| Status Flag | Meaning | Action Needed |
|---|---|---|
QUEUED | Ingestion job is queued on edge worker | None (begins in < 5s) |
PARSING | Extracting text, tables, and code snippets | None |
EMBEDDING | Generating dense vectors and building index | None |
READY | Fully indexed and actively answering queries | Operational |
FAILED | Error encountered (e.g., 404, firewall block) | Check source error logs |