Felo LiveDoc
by @wangzhiming1999
Manage Felo LiveDocs (knowledge bases) and their resources. Use when users want to create, manage, or query knowledge bases, upload documents, add URLs, or p...
clawhub install felo-livedoc๐ About This Skill
name: felo-livedoc description: "Manage Felo LiveDocs (knowledge bases) and their resources. Use when users want to create, manage, or query knowledge bases, upload documents, add URLs, or perform semantic retrieval over a knowledge base. Explicit commands: /felo-livedoc."
Felo LiveDoc Skill
When to Use
Trigger this skill when users want to:
Trigger words:
Explicit commands: /felo-livedoc, "livedoc", "felo livedoc"
Do NOT use for:
Setup
1. Get Your API Key
1. Visit felo.ai and log in (or register) 2. Click your avatar in the top right corner โ Settings 3. Navigate to the "API Keys" tab 4. Click "Create New Key" to generate a new API Key 5. Copy and save your API Key securely
2. Configure API Key
Set the FELO_API_KEY environment variable:
Linux/macOS:
export FELO_API_KEY="your-api-key-here"
Windows (PowerShell):
$env:FELO_API_KEY="your-api-key-here"
How to Execute
When this skill is triggered, execute the livedoc script using the Bash tool:
LiveDoc Management
Create a LiveDoc:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs create --name "KB Name" --description "Description"
List LiveDocs:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs list
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs list --keyword "search term"
Update a LiveDoc:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs update SHORT_ID --name "New Name" --description "New Desc"
Delete a LiveDoc:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs delete SHORT_ID
Resource Management
Add a text document:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs add-doc SHORT_ID --title "Doc Title" --content "Document content here"
Add URLs (max 10, comma-separated):
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs add-urls SHORT_ID --urls "https://example.com,https://example.org"
Upload a file:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs upload SHORT_ID --file ./document.pdf
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs upload SHORT_ID --file ./document.pdf --convert
List resources:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs resources SHORT_ID
Get a single resource:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs resource SHORT_ID RESOURCE_ID
Delete a resource:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs remove-resource SHORT_ID RESOURCE_ID
Semantic Retrieval
Search across resources:
node ~/.agents/skills/felo-livedoc/scripts/run_livedoc.mjs retrieve SHORT_ID --query "your search query"
Options
All commands support:
--json or -j โ output raw JSON response--timeout or -t โ request timeout in milliseconds (default: 60000)Parse and Format Response
The API returns JSON with this structure:
{
"status": "ok",
"message": "success",
"data": { ... }
}
LiveDoc object:
short_id โ unique identifier (use this for all operations)name โ LiveDoc namedescription โ LiveDoc descriptioncreated_at / modified_at โ timestampsResource object:
id โ resource identifiertitle โ resource titleresource_type โ type (web, ai_doc, file, etc.)status โ processing statussnippet โ content previewRetrieve result:
id โ resource IDtitle โ resource titlecontent โ matched contentscore โ relevance score (0-1)Error Handling
Common Error Codes
INVALID_API_KEY โ API Key is invalid or revokedLIVEDOC_NOT_FOUND โ LiveDoc does not existLIVEDOC_RESOURCE_NOT_FOUND โ Resource does not existLIVEDOC_CREATE_FAILED โ Failed to create LiveDocLIVEDOC_RESOURCE_UPLOAD_FAILED โ File upload failedLIVEDOC_RESOURCE_ADD_URLS_FAILED โ URL addition failedLIVEDOC_RESOURCE_RETRIEVE_FAILED โ Semantic retrieval failedMissing API Key
If FELO_API_KEY is not set, display this message:
ERROR: FELO_API_KEY not set. Get your API key from https://felo.ai (Settings โ API Keys).
Set it with: export FELO_API_KEY="your-key"
Important Notes
short_id returned from create/list to reference a LiveDoc--convert with upload to convert files to searchable documentsโก When to Use
โ๏ธ Configuration
All commands support:
--json or -j โ output raw JSON response--timeout or -t โ request timeout in milliseconds (default: 60000)Parse and Format Response
The API returns JSON with this structure:
{
"status": "ok",
"message": "success",
"data": { ... }
}
LiveDoc object:
short_id โ unique identifier (use this for all operations)name โ LiveDoc namedescription โ LiveDoc descriptioncreated_at / modified_at โ timestampsResource object:
id โ resource identifiertitle โ resource titleresource_type โ type (web, ai_doc, file, etc.)status โ processing statussnippet โ content previewRetrieve result:
id โ resource IDtitle โ resource titlecontent โ matched contentscore โ relevance score (0-1)