Skip to main content

Knowledge Commands

See Knowledge module docs for permissions and data model.

soat search-knowledge​

Search knowledge

  • Method: POST
  • Path: /api/v1/knowledge/search

Usage​

soat search-knowledge

Options​

--project-id​

Limit search to a specific project

  • Source: body
  • Required: no
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--query​

Semantic search query text

  • Source: body
  • Required: no
  • Type: string
  • Example: customer communication preferences
--min-score​

Minimum score a result must reach to be returned. Filters on the implementation-defined score, not on similarity_score, so the cutoff follows the ranking. Only applies when query is provided. Because the scale behind score is not part of the contract, treat a tuned value as tied to the deployment rather than portable.

  • Source: body
  • Required: no
  • Type: number
  • Example: 0.5
--limit​

Maximum number of results to return (default 10)

  • Source: body
  • Required: no
  • Type: integer
  • Example: 10
--memory-ids​

Search entries within these specific memories

  • Source: body
  • Required: no
  • Type: array<string>
  • Example: ["mem_V1StGXR8Z5jdHi6B"]
--memory-tags​

Search entries in memories whose tags match any of these patterns (glob supported)

  • Source: body
  • Required: no
  • Type: array<string>
  • Example: ["customer*","support"]
--document-paths​

Filter results to documents whose file path starts with one of these prefixes

  • Source: body
  • Required: no
  • Type: array<string>
  • Example: ["/sales/","/hr/"]
--document-ids​

Filter results to specific document IDs

  • Source: body
  • Required: no
  • Type: array<string>
  • Example: ["doc_V1StGXR8Z5jdHi6B"]