Vulavula Logo
Vulavula API

​search

Find answers in a collection of documents.

​Create Knowledge Base

POST
/api/v1/search/knowledgebase

​Create Knowledge Base › Request Body

  • knowledgebase_namestring · required

​Create Knowledge Base › Responses

    • idstring · uuid · required
    • knowledgebase_namestring · required

​Get Customer Knowledge Bases

GET
/api/v1/search/knowledgebases

​Get Customer Knowledge Bases › Responses

    object[]
    • idstring · uuid · required
    • knowledgebase_namestring · required
    • documentsobject[] · required

​Add Document To Knowledgebase

POST
/api/v1/search/knowledgebase/{knowledgebase_id}/document

​Add Document To Knowledgebase › path Parameters

  • knowledgebase_idstring · uuid · required

​Add Document To Knowledgebase › Request Body

  • filestring · binary · required

    The file to upload

​Add Document To Knowledgebase › Responses

    • idstring · uuid · required
    • knowledgebase_idstring · uuid · required
    • filenamestring · required

​Get Knowledgebase Documents

GET
/api/v1/search/knowledgebase/{knowledgebase_id}/documents

​Get Knowledgebase Documents › path Parameters

  • knowledgebase_idstring · uuid · required

​Get Knowledgebase Documents › Responses

    object[]
    • idstring · uuid · required
    • knowledgebase_idstring · uuid · required
    • filenamestring · required

​Search Knowledgebase

POST
/api/v1/search/knowledgebase/{knowledgebase_id}/query

​Search Knowledgebase › path Parameters

  • knowledgebase_idstring · uuid · required

​Search Knowledgebase › Request Body

  • querystring · required
  • language

​Search Knowledgebase › Responses

    • search_resultsobject[] · required

​Delete Knowledgebase

DELETE
/api/v1/search/knowledgebase/{knowledgebase_id}

​Delete Knowledgebase › path Parameters

  • knowledgebase_idstring · uuid · required

​Delete Knowledgebase › Responses

    No response specified

​Delete Knowledgebase Document

DELETE
/api/v1/search/knowledgebase/document/{document_id}

​Delete Knowledgebase Document › path Parameters

  • document_idstring · uuid · required

​Delete Knowledgebase Document › Responses

    No response specified