End Points

1. POST /create/project

Description: Project is required to get the key for your account.Please save your settings as you won't be able to get it back.

Parameters:
  • name (required) - The name of your project.
Response:
  • message (required) - The message for your project.
  • clientid (required) - The id of your project.
  • name (required) - The name of your project.
  • clientkey (required) - The key of your project.
2. POST /upload/document

Description: Upload your document into platform for questioning. For document storage, bizzscan provides you 3-level of hierarchy. These levels are project, business function and business area and present in input parameters as.

Some of the examples of these values are:

for HR Recruitment:
  • businessfunction: hr
  • businessarea: recruitment
for HR Payroll:
  • businessfunction: hr
  • businessarea: payroll
Headers:
  • clientid (required) - The clientid asssociated with your project.
  • clientkey (required) - The clientkey asssociated with your project.
Parameters:
  • file (required) - string($binary)
  • businessfunction (required) - string
  • businessarea (required) - string
Request:
Response:
  • message - The message for your project.
  • id - The document id of your document.
3. GET /get/documents

Description: You can retrieve the metadata of uploaded document from this APIs within your document hierarchy.

for HR:
  • businessfunction: hr
  • businessarea: recruitment
Headers:
  • clientid (required) - The clientid asssociated with your project.
  • clientkey (required) - The key asssociated with your project.
Parameters:
  • pageno (optional) - string (default value : 1)
  • limit (optional) - string (default value : 10)
  • businessfunction (required) - string
  • businessarea (required) - string
Request:
Response:
  • documents - list of your documents.
  • documentpath (required) - The path of your document.
  • id - The document id of your document.
4. POST /add/field

Description: Field addition to your index will allow full control on its behavior.

Headers:
  • clientid (required) - The clientid asssociated with your project.
  • clientkey (required) - The clientkey asssociated with your project.
Parameters:
  • indexId (required) - The id of your index.
  • fields (required) - part of request body which takes 2 inputs:
    1. variable name (part of index)
    2. Instructions (define the rules)
Request:
Response:
5. POST /create/index

Description: Index creation will give you full control over the information which you want to extract from document.

Headers:
  • clientid (required) - The clientid asssociated with your project.
  • clientkey (required) - The clientkey asssociated with your project.
Parameters:
  • indexes (required) - Request body contains name, activation flag and fields of index.
    If you set the activate flag to True then index status will become "PROCESS" and it will be blocked for modification.After the indexing job will finish, the status will again become "ACTIVE".
  • documentId (required) - ID of your document.
Request:
Response:
6. POST /activate/index

Description: Activation of Index will allow index application of associated documents .

Headers:
  • clientid (required) - The clientid asssociated with your project.
  • clientkey (required) - The clientkey asssociated with your project.
Parameters:
  • indexId (required) - The id of your index.
Request:
Response:
Important: Index activation will set the index status to "PROCESS" which means it is blocked for document processing.
7. GET /index

Description: Give you summary of all your indexes created under your project.

Headers:
  • clientid (required) - The clientid asssociated with your project.
  • clientkey (required) - The clientkey asssociated with your project.
Request:
Response:
8. GET /index/{indexId}

Description: Give you summary of your specific index given as path variable created under your project.

Headers:
  • clientid (required) - The clientid asssociated with your project.
  • clientkey (required) - The clientkey asssociated with your project.
Request:
Response:
9. POST /ask/question

Description: Once you get the notification that indexing of your document is complete, then you can ask the question.

Headers:
  • clientid (required) - The clientid asssociated with your project.
  • clientkey (required) - The clientkey asssociated with your project.
Parameters:
  • question (required) - question which you want to ask.
  • documentId (required) - Scope ID of the document.
  • includeall (required) - Search in whole folder.
Request:
Response: