Search Knowledge

Search the knowledge base for relevant documents using query, filters and search type.

POST /knowledge/search

Search Knowledge

cURL

curl --request POST \
  --url https://api.example.com/knowledge/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "db_id": "<string>",
  "vector_db_ids": [
    "<string>"
  ],
  "search_type": "<string>",
  "max_results": 123,
  "filters": {},
  "meta": {
    "limit": 20,
    "page": 1
  }
}
'

200

{
  "data": [
    {
      "id": "doc_123",
      "content": "Jordan Mitchell - Software Engineer with skills in JavaScript, React, Python",
      "name": "cv_1",
      "meta_data": {
        "page": 1,
        "chunk": 1
      },
      "usage": {
        "total_tokens": 14
      },
      "reranking_score": 0.95,
      "content_id": "content_456"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total_pages": 2,
    "total_count": 35
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Schema for vector search request.

query · string · required

The search query

db_id · string | null

The content database id

vector_db_ids · string[] | null

List of vector database ids to search in

search_type · string | null

The type of search to perform

max_results · integer | null

The maximum number of results to return

filters · Filters · object

The filters to apply to the search

meta · Meta · object

Pagination metadata. Limit and page number to return a subset of results.

Show child attributes

Response

200

application/json

Search results retrieved successfully

data · VectorSearchResult · object[] · required

Show child attributes

meta · PaginationInfo · object · required

Show child attributes