NOnoxus
V1 - Knowledge Bases

Search Knowledge Base Documents

Search documents by file name using fuzzy matching.

get/v1/knowledge-bases/{knowledge_base_id}/documents/search

Request

  • Base URL
    https://api.app.noxus.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header X-API-Key

Path parameters

knowledge_base_idstring required

Query parameters

querystring required

File name search query

prefixstring nullable

Folder prefix filter

limitinteger

Max results

Response

Successful Response

idstring uuid required
summarystring nullable required
short_summarystring nullable
doc_typestring nullable
source_typestring nullable
source_external_idstring nullable
source_metadataobject nullable
content_typestring nullable
has_conversionboolean nullable
status'trained' | 'training' | 'error' | 'uploaded' | 'folder' | 'outdated' required
doc_metadataobject nullable
errorobject nullable required
namestring nullable
prefixstring nullable
uristring nullable
updated_atstring date-time required
created_atstring date-time required
sizeinteger required
file_idstring uuid nullable
run_idstring uuid nullable
dismissedboolean nullable
needs_reingestionboolean nullable

Changes

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