KnowledgeBaseExplorer

Search Keywords In Knowledge Base

Search for keywords within a specific knowledge base using keyword-based search.

This endpoint performs keyword-based searches within a knowledge base, looking for specific terms or phrases. It validates that the knowledge base exists, is public, and contains searchable data.

Parameters:

  • request: HTTP request object containing authentication information
  • knowledge_uuid: UUID of the knowledge base to search within
  • term: Search term (3-128 characters) for keyword matching
  • workspace_uuid: Optional workspace UUID for context

Returns:

  • List of keyword search results matching the query term

Raises:

  • HTTPException: If knowledge base not found, not public, contains no data, or if no search results are found
get/knowledge-base/explorer/{knowledge_uuid}/search/keywords

Request

  • Base URL: https://api.platform.v1.aureo.io
  • URL: https://api.platform.v1.aureo.io/knowledge-base/explorer/{knowledge_uuid}/search/keywords
  • Auth: API key in header api_key and API key in header api_secret

Path parameters

knowledge_uuidstring required

Query parameters

termstring required
workspace_uuidstring

Response

Successful Response

unknown required

Changes

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