knowledge-documents

Search Documents

Search indexed knowledge documents with mode selection.

Supports three search modes:

  • semantic: Vector similarity search using embeddings (best for conceptual queries)
  • keyword: Traditional text-based search (best for exact matches)
  • hybrid: Combination of both (recommended, default)

Request Body:

  • query: Search query text (required, 1-1000 characters)
  • mode: Search mode (semantic, keyword, hybrid). Default: hybrid
  • source_ids: Optional list of source IDs to filter by
  • limit: Maximum results (1-100). Default: 20
  • offset: Number of results to skip. Default: 0

Response:

  • results: List of search results with relevance scores
  • total: Total matching documents
  • mode_used: The search mode that was used

Scores: Each result includes:

  • score: Raw relevance score from search engine
  • normalized_score: Score normalized to 0-100 range (100 = best match)

Security: Search is scoped to the authenticated user's account index.

post/api/v1/knowledge/documents/search

Request

  • Base URL: https://api.gnosari.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.gnosari.com/api/v1/knowledge/documents/search
  • Auth: one of:
    • HTTP bearer
    • API key in header X-AUTH-TOKEN

Request body

querystring required

Search query text

mode'semantic' | 'keyword' | 'hybrid'

Search mode for knowledge queries.

  • semantic: Vector similarity search using embeddings
  • keyword: Traditional text-based search
  • hybrid: Combination of semantic and keyword search (recommended)
source_idsstring[] nullable

Filter by source IDs

limitinteger

Maximum results to return

offsetinteger

Number of results to skip

Response

Successful Response

totalinteger

Total matching documents

mode_used'semantic' | 'keyword' | 'hybrid'

Search mode for knowledge queries.

  • semantic: Vector similarity search using embeddings
  • keyword: Traditional text-based search
  • hybrid: Combination of semantic and keyword search (recommended)

Changes

No recorded changes to this operation across all 1 revision of this API.