Skip to main content
POST
/
v1
/
knowledgebase
/
search
{
  "clusterId": "10cf44d8-4d77-4550...",
  "query": "What is best SEO Agency in Innsbruck?",
  "topK": 5
}
{
  "status": true,
  "data": {
    "results": [
      {
        "id": "8b7499ba-f333-4519-809d-8645ee2850e2-0",
        "score": 0.5415377,
        "metadata": {
          "clusterId": "ce419c96-17fa-4762...",
          "fileId": "8b7499ba-f333-4519...",
          "filename": "filename.md",
          "name": "filename.md",
          "text": "..."
        }
      }
    ],
    "count": 5
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.evergreens.ai/llms.txt

Use this file to discover all available pages before exploring further.

AuthorAuthor: Adnan Ali
Entity Reference:
KnowledgebaseEntity
Search for relevant information in the knowledge base using a query string.
Rate Limit: The Knowledge Base Search API is currently rate limited to 30 requests every 60 seconds to ensure optimal performance and reliability. If you exceed this limit, you may receive a 429 Too Many Requests response. We recommend implementing retry logic with exponential backoff in your application to handle rate limit responses gracefully.

Request

query
string
required
The search query string to find relevant information in the knowledge base. Max length: 500 characters.
clusterId
string
An optional cluster ID to limit the search in a specific cluster. If not provided, the search will be performed across all clusters in the knowledge base.
topK
number
default:10
The number of top relevant results to return. Default is 10. Minimum is 1 and maximum is 20.

Response

The response contains an array of relevant results from the knowledge base based on the search query.
results
array
required
An array of search results, where each result includes the following fields:
count
number
required
The total number of relevant results found for the search query.
{
  "status": true,
  "data": {
    "results": [
      {
        "id": "8b7499ba-f333-4519-809d-8645ee2850e2-0",
        "score": 0.5415377,
        "metadata": {
          "clusterId": "ce419c96-17fa-4762...",
          "fileId": "8b7499ba-f333-4519...",
          "filename": "filename.md",
          "name": "filename.md",
          "text": "..."
        }
      }
    ],
    "count": 5
  }
}
{
  "clusterId": "10cf44d8-4d77-4550...",
  "query": "What is best SEO Agency in Innsbruck?",
  "topK": 5
}