​

search_knowledge

​

Use Cases

• Answer questions using project knowledge
• Retrieve information from uploaded documents
• Search across webpages and knowledge items
• Get context-aware answers with source attribution

​

Parameters

​

Response

​

Example Request

{
  "query": "How do I configure authentication?",
  "context": "Setting up a new project and need to understand authentication options"
}

​

Example Response

{
  "success": true,
  "answer": "Authentication can be configured using Clerk. You need to set up an API key in your project settings and use the @require_clerk_auth decorator on your routes. The user_id is automatically injected into route handlers.",
  "sources": [
    {
      "id": "doc_123",
      "type": "document",
      "title": "Authentication Guide",
      "content": "Clerk authentication is required for all API endpoints...",
      "relevance_score": 0.95
    },
    {
      "id": "web_456",
      "type": "webpage",
      "title": "API Documentation",
      "content": "Use @require_clerk_auth decorator to protect routes...",
      "relevance_score": 0.87
    }
  ],
  "query": "How do I configure authentication?"
}

​

Behavior

• Searches across all project knowledge (no agent scoping)
• Uses semantic search to find relevant content
• Synthesizes information from multiple sources using LLM
• Returns sources with relevance scores
• Handles queries in natural language

​

Search Quality Tips

1. Use specific queries: “How to set up authentication” is better than “auth”
2. Include context: Provide background information in the context parameter
3. Use multiple words: Queries with 2+ words generally perform better
4. Be clear about intent: State what you’re trying to accomplish

​

Error Handling

​

Knowledge Sources

• Documents: Uploaded PDFs, text files, markdown files
• Webpages: Saved web pages and URLs
• Knowledge Items: Manually added knowledge entries

​

Best Practices

1. Be specific: Clear, detailed queries get better results
2. Provide context: Use the context parameter to improve relevance
3. Review sources: Check source citations to verify information
4. Iterate on queries: If results aren’t good, refine your query

​

Limitations

• Search is scoped to the project associated with the API key
• Results depend on the quality and quantity of knowledge in the project
• Very new knowledge may take a few moments to be indexed