Quick Reference

Fast-access reference for Knowledge Base commands, status codes, and common operations.

Document Types

Type Processing Time Best For Limit
URL 30-60 sec Single pages N/A
Crawl 2-10 min Multi-page sites 100 pages
File 5-10 sec Existing docs 10 MB
Text < 5 sec Quick content No limit

Status Indicators

Status Meaning Action
Pending Queued Wait
Processing Working Wait (30s-10min)
Uploading Sending to AI platform Wait (<30s)
Uploaded Ready Attach to agents
Error Failed Click retry

Prerequisites

Before using Knowledge Base:

  • Add Custom Agent in Project Settings → AMA
  • Get agent ID configured (contact support@cast.app)
  • Note: Knowledge Base Documents section appears after agent ID is configured

Quick Start Workflow

1. Add Custom Agent (Project Settings → AMA)
   ↓
2. Get Agent ID configured (contact support@cast.app)
   → Knowledge Base Documents section will appear
   ↓
3. Access Knowledge Base (book icon in nav)
   ↓
4. Create Document (URL/Crawl/File/Text tab)
   ↓
5. Wait for "Uploaded" status
   ↓
6. Go to Project Settings → AMA → Agent Personas
   ↓
7. Knowledge Base Documents section → Click "Attach Documents"
   ↓
8. Select documents → Click "Attach Selected"
   ↓
9. Test agent with questions

Common URLs for Testing

Documentation Sites:

https://docs.github.com/en/get-started/quickstart
https://react.dev/learn
https://www.python.org/about/

Articles:

https://www.paulgraham.com/startupideas.html
https://en.wikipedia.org/wiki/Artificial_intelligence

Sample Crawl Configuration

Documentation Site:

Base URL: https://docs.yourcompany.com
Max Pages: 10
Include: /docs/*, /guides/*
Exclude: /api/*, *.pdf

Blog Archive:

Base URL: https://blog.yourcompany.com
Max Pages: 10
Include: /posts/*, /articles/*
Exclude: /author/*, /category/*

Sample Inline Text

FAQ Format:

Title: Product FAQ

Content:
Q: What are your hours?
A: Monday-Friday, 9 AM - 5 PM EST.

Q: How to contact support?
A: Email support@cast.app

Document Actions

Icon Action Description
Eye Preview View content (text only)
Arrow Download Get original file
Circular Arrow Refresh Re-scrape URL (auto-updates agents)
Retry Retry Retry failed upload
Trash Delete Remove document

Supported File Formats

Accepted:

  • PDF (.pdf)
  • Markdown (.md)
  • Plain Text (.txt)
  • HTML (.html)
  • CSV (.csv)
  • JSON (.json)

Not Supported:

  • DOCX, XLSX, ZIP, EXE, Images

Limits and Constraints

File Size: 10 MB max
Crawl Pages: 100 pages max
Processing: Up to 10 minutes for large crawls
URLs: Must be publicly accessible

Troubleshooting Quick Fixes

Issue Quick Fix
Stuck in “Processing” Wait 10 min → Refresh page → Delete & recreate
“Failed to scrape” Check URL is public → Try different page
“File too large” Use file <10 MB → Split into smaller files
Agent can’t see doc Wait for “Uploaded” → Attach to agent
Can’t delete doc Detach from all agents → Then delete

Best Practices Checklist

Creating Documents:

  • Use descriptive titles
  • Start with small crawls (5-10 pages)
  • Test URLs in browser first
  • Keep files under 5 MB

Managing Documents:

  • Search before creating to avoid duplicates
  • Review content before attaching
  • Refresh URL docs monthly
  • Clean up outdated documents

Agent Integration:

  • Start with 1-2 documents per agent
  • Test agent responses after attaching
  • Use focused, topic-specific documents
  • Detach before deleting

Keyboard Shortcuts

Currently no keyboard shortcuts available. Navigate using mouse/trackpad.

Processing Time Expectations

Fast (<10 seconds):

  • Inline text
  • File upload

Medium (30-60 seconds):

  • Single URL

Slow (2-10 minutes):

  • Website crawl
  • Depends on page count

Common Error Messages

“Failed to scrape URL”

  • URL not publicly accessible
  • Website blocks scrapers
  • Try different page

“File too large”

  • Exceeds 10 MB limit
  • Compress or split file

“Processing timeout”

  • Took too long to process
  • Reduce crawl max_pages

“Invalid file format”

  • File type not supported
  • Convert to supported format

Attachment Workflow

To Attach:

Project Settings → AMA → Agent Personas → 
Knowledge Base Documents → Attach Documents → 
Select → Attach Selected

To Detach:

Find document in attached list → 
Click Detach → Confirm

Search Tips

  • Search is case-insensitive
  • Searches title and source
  • Real-time filtering
  • Use partial words

Examples:

  • “github” finds all GitHub documents
  • “faq” finds all FAQ documents
  • “docs” finds documentation URLs

Document Status Flow

Create Document
  ↓
Pending (gray)
  ↓
Processing (blue)
  ↓
Uploading (blue)
  ↓
Uploaded (green) âś“
  ↓
Attach to Agent

If Error (red):
  ↓
Click Retry → Back to Pending

Access Points

Knowledge Base Page:

  • Top navigation → Book icon

Agent Attachment:

  • Projects → Settings → AMA → Agent Personas → Knowledge Base Documents

Organization Structure

Organization
  └── Knowledge Base (shared)
       └── Document 1
       └── Document 2
       └── Document 3
            └── Attached to Agent A (Project 1)
            └── Attached to Agent B (Project 2)

Automatic Update Flow

Refresh Document
  ↓
System re-scrapes content
  ↓
Creates new version
  ↓
Finds all attached agents
  ↓
Updates each agent automatically
  ↓
Removes old version
  ↓
Done (no manual re-attachment)

Need Help?


This site uses Just the Docs, a documentation theme for Jekyll.