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.