V1 - Knowledge Bases

Add Knowledge Base V2

post/v1/knowledge-bases

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

Request body

namestring required
descriptionstring required
document_typesstring[]
status'created' | 'trained' | 'training' | 'error'
kb_type'temporary' | 'entity'
workflow_idstring uuid nullable
node_idstring uuid nullable
version'v2' | 'v3'

Response

Successful Response

idstring uuid required
group_idstring uuid required
namestring required
status'created' | 'trained' | 'training' | 'error' required
descriptionstring required
document_typesstring[] required
kb_type'temporary' | 'entity' required
sizenumber required
num_docsinteger required
created_atstring date-time required
updated_atstring date-time required
errorobject nullable required
version'v2' | 'v3' required
summarystring nullable
needs_summary_updateboolean
metaobject nullable
total_documentsinteger required
training_documentsinteger required
trained_documentsinteger required
error_documentsinteger required
uploaded_documentsinteger required
source_typesobject required
training_source_typesstring[] required

Changes

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