Document

Root resource for all document APIs

Add Document to an Application via Word (docx) Ingestion.

Upload a single Word docx file to add a new document to an existing hub application.

Securityapi_key
Request
path Parameters
id
required
string
query Parameters
filename
string

Sets the file name doument metadata. It is not used to etablish uniqueness.

Request Body schema: application/octet-stream
required
string <binary> (Binary File Request)

Binary file e.g. pdf, docx, html

Responses
200

200 response

400

Invalid request body

403

The request is forbidden (Please input a valid API key)

post/hub/apps/{id}/ingestion/docx
Request samples 
Response samples 
application/json
{
  • "status": {
    },
  • "result": {
    }
}
Get Application Document
Get the text content of a specific application document with doc-ID


Securityapi_key 
Request 
path Parameters
did
required
string
Document ID


 
 Example:  49a2758a
id
required
string
Application ID


 
 Example:  b6ee555d61df4c0ae30099d3ba4acf5c-sample-01
Responses 
200
200 response


400
400 response


403
The request is forbidden (Please input a valid API key)


get/hub/apps/{id}/documents/{did}
Request samples 
Response samples 
application/json
{
  • "status": {
    },
  • "result": {
    }
}
Delete Application Document
Delete a specific application document with doc-ID


Securityapi_key 
Request 
path Parameters
did
required
string
Document ID


 
 Example:  d00a2811
id
required
string
Application ID


 
 Example:  b6ee555d61df4c0ae30099d3ba4acf5c-sample-01
Responses 
200
200 response


403
The request is forbidden (Please input a valid API key)


delete/hub/apps/{id}/documents/{did}
Request samples 
Response samples 
application/json
{
  • "status": {
    },
  • "result": {
    }
}
List All Application Documents
List all application documents


Securityapi_key 
Request 
path Parameters
id
required
string
Application ID


 
 Example:  b6ee555d61df4c0ae30099d3ba4acf5c-sample-01
Responses 
200
200 response


400
400 response


403
The request is forbidden (Please input a valid API key)


get/hub/apps/{id}/documents
Request samples 
Response samples 
application/json
{
  • "status": {
    },
  • "result": {
    }
}
List All Application Document Contents
List all document contents with the specific application-ID and document-ID


Securityapi_key 
Request 
path Parameters
did
required
string
Document ID


 
 Example:  290310a2
id
required
string
Application ID


 
 Example:  b6ee555d61df4c0ae30099d3ba4acf5c-sample-01
Responses 
200
200 response


400
400 response


403
The request is forbidden (Please input a valid API key)


get/hub/apps/{id}/documents/{did}/contents
Request samples 
Response samples 
application/json
{
  • "status": {
    },
  • "result": {
    }
}
Create New Application Content
Create a new document content with the application-ID and document-ID


Securityapi_key 
Request 
path Parameters
did
required
string
Document ID


 
id
required
string
Application ID


 
Responses 
200
200 response


403
The request is forbidden (Please input a valid API key)


post/hub/apps/{id}/documents/{did}/contents
Request samples 
Response samples 
application/json
{ }
Add Document to an Application via PDF Ingestion.
Upload a single PDF file to add a new document to an existing hub application.


Securityapi_key 
Request 
path Parameters
id
required
string
 
query Parameters
engine
string
An optional parameter that refers to the PDF parser. It should be 'v1' or 'v2'.  The defult version is 'v2'.


 
y_mul
string
An optional hyper-parameter to control text clustering along the y-axis.


 
filename
string
Sets the file name doument metadata. It is not used to etablish uniqueness.


 
y_mul_small
string
An optional hyper-parameter to control small font-text clustering along the y-axis.


 
w_mul
string
An optional hyper-parameter to control text clustering along the x-axis.


 
y_mul_space
string
An optional hyper-parameter for engine=v2, to control text space clustering along the y-axis. Must be used in conjunction with y_mul.


 
Request Body schema: application/pdf
required
string <binary>  (Binary File Request) 
Binary file e.g. pdf, docx, html


 
Responses 
200
200 response


400
Invalid request body


403
The request is forbidden (Please input a valid API key)


post/hub/apps/{id}/ingestion/pdf
Request samples 
Response samples 
application/json
{
  • "status": {
    },
  • "result": {
    }
}
➔ Next to Search